Skip to content

Rust API reference

Find the public Rust types, build local rustdoc and inspect individual package APIs.

On this page

Use the inrux facade for application code and inrux-compiler as a build dependency. You do not need to import backend crates in portable components.

Build the Rust reference

From the repository root:

sh
cargo doc -p inrux --no-deps --features egui --open

Replace the feature with your selected engine when needed. Use cargo doc -p inrux-core --no-deps --open to inspect a focused crate. rustdoc shows current signatures and error types; this website explains the application workflow around them.

Start with these types

TypeUse it forGuide
NodeEngine-independent component descriptionsComponent catalogue
Style, Color, SizeTyped appearance and dimensionsStyling
Signal<T>, Computed<T>Shared sources and pure derived valuesState
Emit<T>, EventsTyped event delivery and handlersProps and events
ScopeTyped dependency injectionProvide/inject
Context, TaskHandleBackground work and cancellationTasks
StylesheetShared stylesheet replacementThemes
ScrollRequest, ScrollMetricsScroll commands and observationsScrollArea
WindowOptions, FontAssetStartup configuration and fontsArchitecture

Find the implementation

Read the repository structure to locate each package. Each package has a README with examples, module ownership and checks. The adapter contracts do not expose native widget handles. Backend-specific helpers exist in private binding crates for embedding/testing; they are not portable component APIs.

An InstanceHandle identifies retained state. It is not the proposed node/animation ref. Match your code to the current exports and alpha status, rather than relying on API names from planning discussions.

Inrux · Built with Nuxt Content, IPEX, and Akaza UI.