Expand description
Useful imports.
Re-exports§
pub use dioxus_core;
pub use dioxus_hot_reload;
pub use crate::launch::*;
pub use crate::plugins::*;
Modules§
Macros§
- cow_
borrowed - Alias for
Cow::Borrowed
, because that’s used a million times so shortening it is nice. Makes the code more readable. - default_
impl - This macro is used to generate a
impl Default
block for any type with the function new_maybe_sync that takes a genericT
- define_
theme - Example usage:
- eq_
impls - This macro is used to generate
impl PartialEq
blocks for any Readable type that takes a genericT
- fmt_
impls - This macro is used to generate
impl Display
, andimpl Debug
blocks for any Readable type that takes a genericT
- format_
args_ f - hot_
reload_ init - Start the hot reloading server with the current directory as the root
- paste
- read_
impls - This macro is used to generate
impl Display
,impl Debug
,impl PartialEq
, andimpl Eq
blocks for any Readable type that takes a genericT
- render
- The rsx! macro makes it easy for developers to write jsx-style markup in their components.
- rsx
- The rsx! macro makes it easy for developers to write jsx-style markup in their components.
- theme_
with - Create
FooThemeWith
structs without having to deal with the verbose syntax. - to_
owned - A helper macro for cloning multiple values at once
- use_
applied_ theme - This macro has three arguments separator by commas.
- use_
reactive - A helper macro for
use_reactive
that merges uses the closure syntax to elaborate the dependency array - write_
impls - This macro is used to generate
impl Add
,impl AddAssign
,impl Sub
,impl SubAssign
,impl Mul
,impl MulAssign
,impl Div
, andimpl DivAssign
blocks for any Writable type that takes a genericT
Structs§
- Absolute
Position - Accordion
Body Props - Properties for the
AccordionBody
component. - Accordion
Props - Properties for the
Accordion
component. - Accordion
Summary Props - Properties for the
AccordionSummary
component. - Accordion
Theme - Theming properties for the
Accordion
component. - Accordion
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Activable
Route Context - Activable
Route Props - Properties for the
ActivableRoute
component. - Anim
Color - Animate a color.
- AnimNum
- Animate a numeric value.
- Arrow
Icon Props - Properties for the
ArrowIcon
component. - Asset
Cacher - Asset
Configuration - Configuration for a given Asset.
- Attribute
- An attribute on a DOM node, such as
id="my-thing"
orhref="https://example.com"
- Body
Props - Properties for the
Body
component. - Body
Theme - Theming properties for the
Body
component. - Body
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Button
Props - Properties for the
Button
component. - Button
Theme - Theming properties for the
Button
component. - Button
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Canvas
Props - Properties for the
Canvas
component. - Canvas
Theme - Theming properties for the
Canvas
component. - Canvas
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Checkbox
Props - Properties for the
Checkbox
component. - Checkbox
Theme - Theming properties for the
Checkbox
component. - Checkbox
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Config
- Context
- Copy
Value - CopyValue is a wrapper around a value to make the value mutable and Copy.
- Coroutine
- Cross
Icon Props - Properties for the
CrossIcon
component. - Cursor
Area Props - Properties for the
CursorArea
component. - Desktop
Renderer - Desktop renderer for Freya.
- Drag
Provider Props - Properties for the
DragProvider
component. - Drag
Zone Props - Properties for the
DragZone
component. - Drop
Zone Props - Properties for the
DropZone
component. - Dropdown
Item Props - Properties for the
DropdownItem
component. - Dropdown
Item Theme - Theming properties for the
DropdownItem
component. - Dropdown
Item Theme With - You can use this to change a theme for only one component, with the
theme
property. - Dropdown
Props - Properties for the
Dropdown
component. - Dropdown
Theme - Theming properties for the
Dropdown
component. - Dropdown
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Editable
Config - Create a configuration for a
UseEditable
. - Editor
History - Effect
- A handle to an effect.
- Error
Boundary - A boundary that will capture any errors from child components
- Event
- A wrapper around some generic data that handles the event’s state
- Event
Handler - The callback type generated by the
rsx!
macro when anon
field is specified for components. - File
Data - Data of a Keyboard event.
- Font
Theme - Theming properties for Fonts.
- Font
Theme With - You can use this to change a theme for only one component, with the
theme
property. Theming properties for Fonts. - Gaps
- Gesture
Area Props - Properties for the
GestureArea
component. - Global
Memo - A signal that can be accessed from anywhere in the application and created in a static
- Global
Signal - A signal that can be accessed from anywhere in the application and created in a static
- Graph
Line - Data line for the
Graph
component. - Graph
Props - Properties for the
Graph
component. - Graph
Theme - Theming properties for the
Graph
component. - Graph
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Icon
Theme - Theming properties for the
Icon
component. - Icon
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Input
Props - Properties for the
Input
component. - Input
Theme - Theming properties for the
Input
component. - Input
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Keyboard
Data - Data of a Keyboard event.
- Keyboard
Navigator Props - Properties for the
KeyboardNavigator
component. - Launch
Config - Launch configuration.
- Launch
Config Builder - Configuration Builder.
- Layout
Metadata - Layout
Node - Cached layout results of a Node
- Line
- A text line from a TextEditor
- Lines
Iterator - Iterator over text lines.
- Link
Props - Properties for the
Link
component. - Link
Theme - Theming properties for the
Link
component. - Link
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Loader
Props - Properties for the
Loader
component. - Loader
Theme - Theming properties for the
Loader
component. - Loader
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Mapped
Signal - A read only signal that has been mapped to a new type.
- Measure
- Memo
- A value that is memoized. This is useful for caching the result of a computation.
- Menu
Button Props - Properties for the
MenuButton
component. - Menu
Container Props - Properties for the
MenuContainer
component. - Menu
Container Theme - Theming properties for the
MenuContainer
component. - Menu
Container Theme With - You can use this to change a theme for only one component, with the
theme
property. - Menu
Item Props - Properties for the
MenuItem
component. - Menu
Item Theme - Theming properties for the
MenuItem
component. - Menu
Item Theme With - You can use this to change a theme for only one component, with the
theme
property. - Menu
Props - Properties for the
Menu
component. - Modifiers
- Pressed modifier keys.
- Mouse
Data - Data of a Mouse event.
- Native
Router Props - Properties for the
NativeRouter
component. - Navigation
Mark - Network
Image Props - Properties for the
NetworkImage
component. - Network
Image Theme - Theming properties for the
NetworkImage
component. - Network
Image Theme With - You can use this to change a theme for only one component, with the
theme
property. - Node
- Node layout configuration
- Owner
- Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped.
- Platform
Information - Information about the platform.
- Pointer
Data - Data of a Mouse event.
- Popup
Background Props - Properties for the
PopupBackground
component. - Popup
Content Props - Properties for the
PopupContent
component. - Popup
Props - Properties for the
Popup
component. - Popup
Theme - Theming properties for the
Popup
component. - Popup
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Popup
Title Props - Properties for the
PopupTitle
component. - Progress
BarProps - Properties for the
ProgressBar
component. - Progress
BarTheme - Theming properties for the
ProgressBar
component. - Progress
BarTheme With - You can use this to change a theme for only one component, with the
theme
property. - Radio
Props - Properties for the
Radio
component. - Radio
Theme - Theming properties for the
Radio
component. - Radio
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Reactive
Context - A context for signal reads and writes to be directed to
- Read
Only Signal - A signal that can only be read from.
- Readable
Value Iterator - An iterator over the values of a
Readable<Vec<T>>
. - Rect
- A 2d Rectangle optionally tagged with a unit.
- Resource
- Rope
- A utf8 text rope.
- Rope
Editor - TextEditor implementing a Rope
- Runtime
- A global runtime that is shared across all scopes that provides the async runtime and context API
- Runtime
Guard - A guard for a new runtime. This must be used to override the current runtime when importing components from a dynamic library that has it’s own runtime.
- ScopeId
- A component’s unique identifier.
- Scope
State - A component’s rendered state.
- Scroll
BarProps - Properties for the
ScrollBar
component. - Scroll
BarTheme - Theming properties for the
ScrollBar
component. - Scroll
BarTheme With - You can use this to change a theme for only one component, with the
theme
property. - Scroll
Thumb Props - Properties for the
ScrollThumb
component. - Scroll
View Props - Properties for the
ScrollView
component. - Scroll
View Theme - Theming properties for the
ScrollView
component. Also used byVirtualScrollView
. - Scroll
View Theme With - You can use this to change a theme for only one component, with the
theme
property. Also used byVirtualScrollView
. - SetCompare
- An object that can efficiently compare a value to a set of values.
- Sidebar
Item Props - Properties for the
SidebarItem
component. - Sidebar
Item Theme - Theming properties for the
SidebarItem
component. - Sidebar
Item Theme With - You can use this to change a theme for only one component, with the
theme
property. - Sidebar
Props - Properties for the
Sidebar
component. - Sidebar
Theme - Theming properties for the
Sidebar
component. - Sidebar
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Signal
- Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking.
- Signal
Data - The data stored for tracking in a signal.
- Slider
Props - Properties for the
Slider
component. - Slider
Theme - Theming properties for the
Slider
component. - Slider
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Snack
BarBox Props - Properties for the [
SnackBarBox
] component. - Snack
BarProps - Properties for the
SnackBar
component. - Snack
BarTheme - Theming properties for the
SnackBar
component. - Snack
BarTheme With - You can use this to change a theme for only one component, with the
theme
property. - SubMenu
Props - Properties for the
SubMenu
component. - Switch
Props - Properties for the
Switch
component. - Switch
Theme - Theming properties for the
Switch
component. - Switch
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Sync
Storage - A thread safe storage. This is slower than the unsync storage, but allows you to share the value between threads.
- Table
Body Props - Properties for the
TableBody
component. - Table
Cell Props - Properties for the
TableCell
component. - Table
Head Props - Properties for the
TableHead
component. - Table
Props - Properties for the
Table
component. - Table
RowProps - Properties for the
TableRow
component. - Table
Theme - Theming properties for the
Table
component. - Table
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Task
- A task’s unique identifier.
- Template
- A static layout of a UI tree that describes a set of dynamic and static nodes.
- Text
Cursor - Holds the position of a cursor in a text
- Text
Event - Events for TextEditor
- Theme
- Theme
Provider Props - Properties for the
ThemeProvider
component. - Tick
Icon Props - Properties for the
TickIcon
component. - Ticker
- Tile
Props - Properties for the
Tile
component. - Tile
Theme - Theming properties for the
Tile
component. - Tile
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Tooltip
Props - Properties for the
Tooltip
component. - Tooltip
Theme - Theming properties for the
Tooltip
component. - Tooltip
Theme With - You can use this to change a theme for only one component, with the
theme
property. - Torin
- Touch
Data - Data of a Touch event.
- Unbounded
Receiver - The receiving end of an unbounded mpsc channel.
- Unbounded
Sender - The transmission end of an unbounded mpsc channel.
- Uniforms
Builder - Pass uniform values to a Shader.
- Unsync
Storage - A unsync storage. This is the default storage type.
- UseAnimator
- Animate your elements. Use
use_animation
to use this. - UseCallback
- This callback is not generic over a return type so you can hold a bunch of callbacks at once
- UseCanvas
- Holds a rendering hook callback that allows to render to the Canvas.
- UseCanvas
Runner - UseEditable
- Manage an editable content.
- UseFocus
- Manage the focus operations of given Node
- UseForm
- Form controller
- UseFuture
- UsePlatform
- VNode
- A reference to a template along with any context needed to hydrate it
- VNode
Inner - A reference to a template along with any context needed to hydrate it
- Virtual
Dom - A virtual node system that progresses user events and diffs UI trees.
- Virtual
Scroll View Props - Properties for the
VirtualScrollView
component. - Wheel
Data - Data of a Wheel event.
- Window
Config - Configuration for a Window.
- Window
Env - Manager for a Window
- Writable
Value Iterator - An iterator over the values of a
Writable<Vec<T>>
. - Write
- A mutable reference to a signal’s value.
Enums§
- Accordion
Status - Indicates the current status of the accordion.
- Align
Axis - Alignment
- Alignment
Direction - Anim
Direction - Controls the direction of the animation.
- Asset
Age - Defines the duration for which an Asset will remain cached after it’s user has stopped using it. The default is 1h (3600s).
- Borrow
Error - An error that can occur when trying to borrow a value.
- Borrow
MutError - An error that can occur when trying to borrow a value mutably.
- Button
Status - Identifies the current status of the Button.
- Code
- Code is the physical position of a key.
- Content
- Cow
- A clone-on-write smart pointer.
- Cursor
Icon - Describes the appearance of the (usually mouse) cursor icon.
- Custom
Attribute Values - Group all the custom attribute types
- Direction
Mode - Dropdown
Item Status - Current status of the DropdownItem.
- Dropdown
Status - Current status of the Dropdown.
- Dynamic
Calculation - Ease
- Editable
Event - Events emitted to the
UseEditable
. - Editable
Mode - How the editable content must behave.
- Force
- Describes the force of a touch event
- Function
- Gesture
- Gesture emitted by the
GestureArea
component. - History
Change - Input
Mode - Enum to declare is
Input
hidden. - Input
Status - Indicates the current status of the Input.
- Key
- Key represents the meaning of a keypress.
- Link
Tooltip - Tooltip configuration for the
Link
component. - Menu
Item Status - Indicates the current status of the MenuItem.
- Mouse
Button - Describes a button of a mouse controller.
- OnFinish
- What to do once the animation finishes. By default it is
Stop
- Order
Direction - Sorting direction for items in
Table
. - Pointer
Type - The type of device that triggered a Pointer event.
- Position
- Root
Node Candidate - Contains the best Root node candidate from where to start measuring
- Size
- Slider
Status - Describes the current status of the Slider.
- Switch
Status - Describes the current status of the Switch.
- Template
Attribute - An attribute of the TemplateNode, created at compile time
- Template
Node - A statically known node in a layout.
- Tile
Status - Indicates the current status of the Tile.
- Touch
Phase - Describes touch-screen input state.
- Uniform
Value - Uniform value to be passed to a Shader.
- UseFuture
State - A signal that represents the state of a future
- UsePlatform
Error - UseResource
State - A signal that represents the state of the resource
Constants§
Traits§
- Animated
Value - AnyStorage
- A trait for any storage backing type.
- Area
Model - Component
Function - Any component that implements the
ComponentFn
trait can be used as a component. - DOMAdapter
- Default
- A trait for giving a type a useful default value.
- Dependency
- A dependency is a trait that can be used to determine if a effect or selector should be re-run.
- Dependency
Element - A dependency is a trait that can be used to determine if a effect or selector should be re-run.
- HasAttributes
- A trait for anything that has a dynamic list of attributes
- Into
Attribute Value - A value that can be converted into an attribute value
- Into
DynNode - A trait that allows various items to be converted into a dynamic node for the rsx macro
- Layout
Measurer - NodeKey
- 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 theProperties
trait automatically as guarantee that your memoization strategy is safe. - Readable
- A trait for states that can be read from like
crate::Signal
,crate::GlobalSignal
, orcrate::ReadOnlySignal
. You may choose to accept this trait as a parameter instead of the concrete type to allow for more flexibility in your API. For example, instead of creating two functions, one that accepts acrate::Signal
and one that accepts acrate::GlobalSignal
, you can create one function that accepts aReadable
type. - Readable
Option Ext - An extension trait for Readable<Option
> that provides some convenience methods. - Readable
VecExt - An extension trait for Readable<Vec
> that provides some convenience methods. - Scaled
- Storage
- A trait for a storage backing type. (RefCell, RwLock, etc.)
- Super
From - A enhanced version of the
From
trait that allows with more flexibility. - Super
Into - A enhanced version of the
Into
trait that allows with more flexibility. - Text
Editor - Common trait for editable texts
- Throw
- A trait to allow results to be thrown upwards to the nearest Error Boundary
- Writable
- A trait for states that can be read from like
crate::Signal
, orcrate::GlobalSignal
. You may choose to accept this trait as a parameter instead of the concrete type to allow for more flexibility in your API. For example, instead of creating two functions, one that accepts acrate::Signal
and one that accepts acrate::GlobalSignal
, you can create one function that accepts aWritable
type. - Writable
Option Ext - An extension trait for Writable<Option
> that provides some convenience methods. - Writable
VecExt - An extension trait for Writable<Vec
> that provides some convenience methods.
Functions§
- Accordion
- Show other elements under a collapsable box.
- Accordion
Body - Intended to wrap the body of an
Accordion
. - Accordion
Summary - Intended to use as summary for an
Accordion
. - Activable
Route - Provide a context to the inner components so they can know whether the passed route is the current router in the Router or not.
- Arrow
Icon - Icon component for an Arrow.
- Body
- Usually used to wrap the application root component.
- Button
- Clickable button.
- Canvas
- Draw anything inside of this canvas.
- Checkbox
- Controlled
Checkbox
component. - Cross
Icon - Icon component for a Cross.
- Cursor
Area - Change the cursor icon when it’s hovering over this component.
- Drag
Provider - Provide a common place for
DragZone
s andDropZone
s to exchange their data. - Drag
Zone - Make the inner children draggable to other
DropZone
. - Drop
Zone - Elements from
DragZone
s can be dropped here. - Dropdown
- Select from multiple options, use alongside
DropdownItem
. - Dropdown
Item - Styling
- Error
Boundary - Create a new error boundary component.
- Fragment
- Create inline fragments using Component syntax.
- Gesture
Area - Detect complex touch gestures such as
Gesture::DoubleTap
. - Graph
- Graph component.
- Input
- Small box to edit text.
- Keyboard
Navigator - Link
- Similar to
Link
, but you can use it in Freya. Both internal routes (dioxus-router) and external links are supported. When using internal routes make sure the Link is descendant of aRouter
component. - Loader
- Styling
- Menu
- Floating menu, use alongside
MenuItem
. - Menu
Button - Like a button, but for
Menu
s. - Menu
Container - Wraps the body of a
Menu
. - Menu
Item - Styling
- Native
Router - Provides native functionalities for a dioxus-router.
- Network
Image - Image component that automatically fetches and caches remote (HTTP) images.
- Popup
- Floating window intended for quick interactions. Also called
Dialog
in other frameworks. - Popup
Background - The background of the
Popup
component. - Popup
Content - Optionally wrap the content of your
Popup
in a styled container. - Popup
Title - Optionally use a styled title inside a
Popup
. - Progress
Bar - Display the progress of something visually. For example: downloading files, fetching data, etc.
- Radio
- Controlled
Radio
component. - Scroll
Bar - Scroll bar used for
crate::ScrollView
andcrate::VirtualScrollView
. - Scroll
Thumb - Scroll thumb used for
crate::ScrollView
andcrate::VirtualScrollView
. - Scroll
View - Scrollable area with bidirectional support and scrollbars.
- Sidebar
- Props
- Sidebar
Item - Props
- Slider
- Controlled
Slider
component. - Snack
Bar SnackBar
component. Use in combination with other components.- SubMenu
- Create sub menus inside a
Menu
. - Switch
- Display whether a state is
true
orfalse
. Commonly used for enabled/disabled scenarios. Example: light/dark theme. - Table
- Table component, composed with
TableHead
andTableBody
. - Table
Body - The body of a
Table
. - Table
Cell - Cell for a
Table
. You can place anything inside. - Table
Head - The head of a
Table
. UseTableRow
inside. - Table
Row - Table row for
Table
. UseTableCell
inside. - Theme
Provider - Provides a
Theme
for all its children. - Tick
Icon - Icon component for a Tick.
- Tile
- Tile component to be used with [
Radio
] and [Checkbox
]. - Tooltip
Tooltip
component- Virtual
Scroll View - One-direction scrollable area that dynamically builds and renders items based in their size and current available size, this is intended for apps using large sets of data that need good performance.
- apply_
value - consume_
context - Consume context from the current scope
- consume_
context_ from_ scope - Consume context from the current scope
- current_
owner - Returns the current owner. This owner will be used to drop any
Copy
state that is created by thegenerational-box
crate. - current_
scope_ id - Get the current scope id
- dynamic_
bytes - Transform some dynamic bytes (e.g: remote image fetched at runtime) into an attribute
- 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.
- generation
- Get the current render since the inception of this component
- get_
align_ axis - has_
context - Check if the current scope has a context
- manage_
key_ event - map_
winit_ key - Return the equivalent Winit’s
Key
in keyboard_types - map_
winit_ modifiers - map_
winit_ physical_ key - Return the equivalent of Winit’s
PhysicalKey
in keyboard_types - needs_
update - Mark the current scope as dirty, causing it to re-render
- needs_
update_ any - Mark the current scope as dirty, causing it to re-render
- parent_
scope - Get the parent of the current scope if it exists
- provide_
context - Provide context to the current scope
- provide_
root_ context - Provide a context to the root scope
- queue_
effect - Queue an effect to run after the next render
- remove_
future - Informs the scheduler that this task is no longer needed and should be removed.
- run_
calculations - Calculate some chained operations with a given value. This value could be for example the width of a node’s parent area.
- schedule_
update - Schedule an update for the current component
- schedule_
update_ any - Schedule an update for any component given its
ScopeId
. - spawn
- Spawns the future but does not return the [
TaskId
] - spawn_
forever - Spawn a future that Dioxus won’t clean up when this component is unmounted
- spawn_
isomorphic - Start a new future on the same thread as the rest of the VirtualDom.
- static_
bytes - Transform some static bytes (e.g: statically linked images or SVGs) into an attribute
- suspend
- Suspended the current component on a specific task and then return None
- try_
consume_ context - Consume context from the current scope
- try_
use_ context - Consume some context in the tree, providing a sharable handle to the value
- use_
activable_ route - use_
after_ render - Push this function to be run after the next render
- use_
animation - Animate your elements easily.
- use_
animation_ with_ dependencies - use_
asset_ cacher - Global caching system for assets.
- use_
before_ render - A hook that allows you to insert a “before render” function.
- use_
callback - A callback that’s always current
- use_
canvas - Register a rendering hook to gain access to the Canvas.
- use_
context - Consume some context in the tree, providing a sharable handle to the value
- use_
context_ provider - Provide some context via the tree and return a reference to it
- use_
coroutine - Maintain a handle over a future that can be paused, resumed, and canceled.
- use_
coroutine_ handle - Get a handle to a coroutine higher in the tree
Analagous to use_context_provider and use_context,
but used for coroutines specifically
See the docs for
use_coroutine
for more details. - use_
drop - Creates a callback that will be run before the component is removed.
This can be used to clean up side effects from the component
(created with
use_effect
). - use_
editable - Create a virtual text editor with it’s own cursor and rope.
- use_
effect use_effect
will subscribe to any changes in the signal values it captures effects will always run after first mount and then whenever the signal values change If the use_effect call was skipped due to an early return, the effect will no longer activate.- use_
error_ boundary - Provide an error boundary to catch errors from child components
- use_
focus - Create a focus manager for a node.
- use_
form - Create a Form controller with a submit callback.
- use_
future - A hook that allows you to spawn a future.
This future will not run on the server
The future is spawned on the next call to
wait_for_next_render
which means that it will not run on the server. To run a future on the server, you should usespawn
directly.use_future
won’t return a value. If you want to return a value from a future, useuse_resource
instead. - use_
get_ theme - Subscribe to
Theme
changes, default theme will be used if there is no providedTheme
. - use_
hook - Store a value between renders. The foundational hook for all other hooks.
- use_
hook_ did_ run - A hook that uses before/after lifecycle hooks to determine if the hook was run
- use_
hook_ with_ cleanup - Use a hook with a cleanup function
- use_
init_ accessibility - Sync both the Focus shared state and the platform accessibility focus
- use_
init_ default_ theme - Provide the default
Theme
. - use_
init_ theme - Provide a custom
Theme
. - use_
memo - Creates a new Memo. The memo will be run immediately and whenever any signal it reads changes.
- use_
node - Subscribe to a Node layout changes.
- use_
node_ signal - Get a signal to read the latest layout from a Node.
- use_
on_ unmount Deprecated - use_
platform - Get access to information and features of the platform.
- use_
reactive - Takes some non-reactive data, and a closure and returns a closure that will subscribe to that non-reactive data as if it were reactive.
- use_
resource - A memo that resolves to a value asynchronously.
Similar to
use_future
butuse_resource
returns a value. SeeResource
for more details. - use_
root_ context - Try to get a value from the root of the virtual dom, if it doesn’t exist, create a new one with the closure provided.
- use_
set_ compare - Creates a new SetCompare which efficiently tracks when a value changes to check if it is equal to a set of values.
- use_
set_ compare_ equal - A hook that returns true if the value is equal to the value in the set compare.
- use_
signal - Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking.
- use_
signal_ sync - Creates a new `Send + Sync`` Signal. Signals are a Copy state management solution with automatic dependency tracking.
- use_
theme - Subscribe to
Theme
changes. - wait_
for_ next_ render - Wait for the next render to complete
- with_
owner - Run a closure with the given owner.
Type Aliases§
- Accessibility
IdCounter - Area
- Component
- A
Component
is a function that takesProperties
and returns anElement
. - Cursor
Point - Element
- An
Element
is a possibly-noneVNode
created by callingrender
on [Scope
] orScopeState
. - Embedded
Fonts - Hovered
Node - Keyboard
Event - Length
- Mouse
Event - Point2D
- Pointer
Event - Readable
Ref - A reference to a value that can be read from.
- Size2D
- Sync
Signal - A signal that can safely shared between threads.
- Touch
Event - Wheel
Event - Window
Builder Hook - Window
Callback - Writable
Ref - A reference to a value that can be read from.
Attribute Macros§
- component
- Streamlines component creation. This is the recommended way of creating components, though you might want lower-level control with more advanced uses.
- inline_
props - Derive props for a component within the component definition.