API Reference
Use the API reference to look up a type, inspect a component's properties, or check a method signature while building. The pages are generated from Rust declarations and documentation comments in the Pax source tree. The guide chapters explain the concepts and show how to combine these APIs into an interface.
If you are starting a project, begin with Getting Started. For an existing project, match the documentation version to your Pax dependency. The development reference may contain changes that are absent from your release; a newer reference page does not establish support in an older build.
Find an API
| What you are working on | Reference | Guide |
|---|---|---|
| Reactive state and computed values | Properties | State and Properties |
| Input events and handler arguments | Events | Events and Rust |
| Text and fonts | Text | Text, Fonts, and Images |
| Shapes, paths, and paint | Drawing values and drawing elements | Drawing and Styling |
| Routes and navigation | Router | Routing |
Read a reference page
A type's Rust declaration shows its field and method types. For a Pax element,
the guide supplies the corresponding template usage: a Rust field such as
Property<String> is an input you can set with a compatible literal or binding.
Templates and
PAXEL explain that authoring syntax.
Read the documentation alongside the signature for defaults, behavior, and target restrictions. An item appearing in the reference does not establish that every backend or platform implements it equally. The relevant guide and source for your release provide the context; the targets chapter explains the build boundary.
Public crates
pax-runtime-api contains author-facing values and reactive APIs. pax-std
contains the standard elements and components used in templates. Browse their
modules when you need more detail than the entry points above:
Engine and maintainer APIs
For primitive implementations and work on Pax itself, continue with the Maintainer Reference. It separates current internal APIs from historical architecture and design notes.