Crate patternfly_dioxus
source · [−]Modules
Dioxus Namespace for HTML
Macros
The rsx! macro makes it easy for developers to write jsx-style markup in their components.
Structs
The callback type generated by the
rsx! macro when an on field is specified for components.A concrete type provider for closures that build VNode structures.
This struct provides an ergonomic API to quickly build VNodes.
Components in Dioxus use the “Context” object to interact with their lifecycle.
A component’s unique identifier.
Every component in Dioxus is represented by a
ScopeState.The receiving end of an unbounded mpsc channel.
The transmission end of an unbounded mpsc channel.
A virtual node system that progresses user events and diffs UI trees.
Enums
A composable “VirtualNode” to declare a User Interface in the Dioxus VirtualDOM.
Traits
A trait for any generic Dioxus Element.
Every “Props” used for a component must implement the
Properties trait. This trait gives some hints to Dioxus
on how to memoize the props and some additional optimizations that can be made. We strongly encourage using the
derive macro to implement the Properties trait automatically as guarantee that your memoization strategy is safe.Functions
Create inline fragments using Component syntax.
This utility function launches the builder method so rsx! and html! macros can use the typed-builder pattern
to initialize a component’s props.
This hook provides some relatively light ergonomics around shared state.
Provide some state for components down the hierarchy to consume without having to drill props.
Maintain a handle over a future that can be paused, resumed, and canceled.
Get a handle to a coroutine higher in the tree
A hook that provides a future that executes after the hooks have been applied
A future that resolves to a value.
use_ref is a key foundational hook for storing state in Dioxus.Store state between component renders.
Type Definitions
A list of attributes
Attribute Macros
Derive props for a component within the component definition.