Module dioxus_core::prelude

Expand description

The purpose of this module is to alleviate imports of many common types

This includes types like Scope, Element, and Component.

Structs

Event
A wrapper around some generic data that handles the event’s state
LazyNodes
A concrete type provider for closures that build VNode structures.
ScopeId
A component’s unique identifier.
ScopeState
A component’s state separate from its props.
Scoped
A wrapper around a component’s ScopeState and properties. The ScopeState provides the majority of methods for the VirtualDom and component state.
TaskId
A task’s unique identifier.
Template
A static layout of a UI tree that describes a set of dynamic and static nodes.
VNode
A reference to a template along with any context needed to hydrate it
VirtualDom
A virtual node system that progresses user events and diffs UI trees.

IntoAttributeValue
A value that can be converted into an attribute value
Properties
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.
Throw
A trait to allow results to be thrown upwards to the nearest Error Boundary

Fragment
Create inline fragments using Component syntax.
fc_to_builder
This utility function launches the builder method so rsx! and html! macros can use the typed-builder pattern to initialize a component’s props.

Component
A Component is a function that takes a Scope and returns an Element.
Element
An Element is a possibly-none VNode created by calling render on Scope or ScopeState.
Scope
A wrapper around the Scoped object that contains a reference to the ScopeState and properties for a given component.