Module freya::prelude

Useful imports.

Re-exports

• pub use dioxus_hot_reload;
• pub use crate::launch::*;
• pub use crate::plugins::*;

Modules

• computed
  Tracked and computed state in Dioxus
• dioxus_elements
• error
• keyboard
• mouse
• pointer
• touch
• wheel

Macros

• cow_borrowed
  Alias for Cow::Borrowed, because that’s used a million times so shortening it is nice. Makes the code more readable.
• debug_location
• define_theme
  Example usage:
• format_args_f
• hot_reload_init
  Start the hot reloading server with the current directory as the root
• paste
• render
  The render! 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 using hooks and properties in async environments.
• use_applied_theme
  This macro has three arguments separator by commas.
• use_callback
• use_future
  A helper macro that merges uses the closure syntax to elaborate the dependency array

Structs

• AccordionBodyProps
  AccordionBody component properties.
• AccordionProps
  Accordion component properties.
• AccordionSummaryProps
  AccordionSummary component properties.
• AccordionTheme
  Theming properties for the Accordion component.
• AccordionThemeWith
  You can use this to change a theme for only one component, with the theme property.
• AnimationManager
  Manage the lifecyle of an Animation.
• ArrowIcon
• ArrowIconTheme
  Theming properties for the ArrowIcon component.
• ArrowIconThemeWith
  You can use this to change a theme for only one component, with the theme property.
• BodyProps
  Body component properties.
• BodyTheme
  Theming properties for the Body component.
• BodyThemeWith
  You can use this to change a theme for only one component, with the theme property.
• BorrowError
  An error returned by [RefCell::try_borrow].
• BorrowMutError
  An error returned by [RefCell::try_borrow_mut].
• ButtonProps
  Button component properties.
• ButtonTheme
  Theming properties for the Button component.
• ButtonThemeWith
  You can use this to change a theme for only one component, with the theme property.
• CanvasProps
  Canvas component properties.
• CanvasTheme
  Theming properties for the Canvas component.
• CanvasThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Config
• Coroutine
• CursorAreaProps
  CursorArea component properties.
• DragProviderProps
  DragProvider component properties.
• DragZoneProps
  DragZone component properties.
• DropZoneProps
  DropZone component properties.
• DropdownItemProps
  DropdownItem component properties.
• DropdownItemTheme
  Theming properties for the DropdownItem component.
• DropdownItemThemeWith
  You can use this to change a theme for only one component, with the theme property.
• DropdownProps
  Dropdown component properties.
• DropdownTheme
  Theming properties for the Dropdown component.
• DropdownThemeWith
  You can use this to change a theme for only one component, with the theme property.
• EditableConfig
  Create a configuration for a UseEditable.
• Event
  A wrapper around some generic data that handles the event’s state
• EventHandler
  The callback type generated by the rsx! macro when an on field is specified for components.
• ExternalLinkProps
  ExternalLink component properties.
• ExternalLinkTheme
  Theming properties for the ExternalLink component.
• ExternalLinkThemeWith
  You can use this to change a theme for only one component, with the theme property.
• FontTheme
  Theming properties for Fonts.
• FontThemeWith
  You can use this to change a theme for only one component, with the theme property. Theming properties for Fonts.
• Gaps
• GestureAreaProps
  GestureArea component properties.
• GraphLine
  Data line for the Graph component.
• GraphProps
  Graph component properties.
• GraphTheme
  Theming properties for the Graph component.
• GraphThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Image
• InputProps
  Input component properties.
• InputTheme
  Theming properties for the Input component.
• InputThemeWith
  You can use this to change a theme for only one component, with the theme property.
• KeyboardData
  Data of a Keyboard event.
• LaunchConfig
  Launch configuration.
• LaunchConfigBuilder
  Configuration Builder.
• LayoutMetadata
• LazyNodes
  A concrete type provider for closures that build VNode structures.
• Line
  A text line from a TextEditor
• LinesIterator
  Iterator over text lines.
• LoaderProps
  Loader component properties.
• LoaderTheme
  Theming properties for the Loader component.
• LoaderThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Measure
• MouseData
  Data of a Mouse event.
• NetworkImageProps
  NetworkImage component properties.
• NetworkImageTheme
  Theming properties for the NetworkImage component.
• NetworkImageThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Node
  Node layout configuration
• NodeAreas
  Cached layout results of a Node
• PointerData
  Data of a Mouse event.
• ProgressBarProps
  ProgressBar component properties.
• ProgressBarTheme
  Theming properties for the ProgressBar component.
• ProgressBarThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Rect
  A 2d Rectangle optionally tagged with a unit.
• Ref
  Wraps a borrowed reference to a value in a RefCell box. A wrapper type for an immutably borrowed value from a RefCell<T>.
• RefCell
  A clone of the standard library’s RefCell type.
• RefMut
  A wrapper type for a mutably borrowed value from a RefCell<T>.
• Rope
  A utf8 text rope.
• RopeEditor
  TextEditor implementing a Rope
• Runtime
  A global runtime that is shared across all scopes that provides the async runtime and context API
• RuntimeGuard
  A gaurd 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.
• 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.
• ScrollBarProps
• ScrollBarTheme
  Theming properties for the ScrollBar component.
• ScrollBarThemeWith
  You can use this to change a theme for only one component, with the theme property.
• ScrollThumbProps
• ScrollViewProps
  ScrollView component properties.
• ScrollViewTheme
  Theming properties for the ScrollView component. Also used by VirtualScrollView.
• ScrollViewThemeWith
  You can use this to change a theme for only one component, with the theme property. Also used by VirtualScrollView.
• SliderProps
  Slider component properties.
• SliderTheme
  Theming properties for the Slider component.
• SliderThemeWith
  You can use this to change a theme for only one component, with the theme property.
• SwitchProps
  Switch component properties.
• SwitchTheme
  Theming properties for the Switch component.
• SwitchThemeWith
  You can use this to change a theme for only one component, with the theme property.
• TableBodyProps
  TableBody component properties.
• TableCellProps
  TableCell component properties.
• TableConfig
• TableHeadProps
  TableHead component properties.
• TableProps
  Table component properties.
• TableRowProps
  TableRow component properties.
• TableTheme
  Theming properties for the Table component.
• TableThemeWith
  You can use this to change a theme for only one component, with the theme property.
• TaskId
  A task’s unique identifier.
• Template
  A static layout of a UI tree that describes a set of dynamic and static nodes.
• TextCursor
  Holds the position of a cursor in a text
• Theme
• ThemeProviderProps
  ThemeProvider component properties.
• Ticker
• TooltipProps
  Tooltip component properties.
• TooltipTheme
  Theming properties for the Tooltip component.
• TooltipThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Torin
• TouchData
  Data of a Touch event.
• TransitionsManager
  Manage the lifecyle of a collection of transitions.
• UnboundedReceiver
  The receiving end of an unbounded mpsc channel.
• UnboundedSender
  The transmission end of an unbounded mpsc channel.
• UniformsBuilder
  Pass uniform values to a Shader.
• UseCanvas
  Holds a rendering hook callback that allows to render to the Canvas.
• UseConst
• UseEditable
  Manage an editable content.
• UseFocus
  Manage the focus operations of given Node
• UseFuture
• UsePlatform
• UseRef
  A type created by the use_ref hook. See its documentation for more details.
• UseSharedState
  State that is shared between components through the context system
• UseState
• 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.
• VirtualScrollViewProps
  VirtualScrollView component properties.
• WheelData
  Data of a Wheel event.
• WindowConfig
  Configuration for a Window.
• WindowEnv
  Manager for a Window

Enums

• AccordionStatus
  Indicates the current status of the accordion.
• AlignAxis
• Alignment
• AlignmentDirection
• Animation
  Animation mode and configuration.
• ButtonStatus
  Identifies the current status of the Button.
• Cow
  A clone-on-write smart pointer.
• CustomAttributeValues
  Group all the custom attribute types
• DirectionMode
• DropdownItemStatus
  Current status of the DropdownItem.
• DropdownStatus
  Current status of the Dropdown.
• DynamicCalculation
• EditableEvent
  Events emitted to the UseEditable.
• EditableMode
  How the editable content must behave.
• FutureState
• Gesture
  Gesture emitted by the GestureArea component.
• ImageStatus
  Image status.
• InputMode
  Enum to declare is Input hidden.
• InputStatus
  Indicates the current status of the Input.
• OrderDirection
• Position
• RootNodeCandidate
  Contains the best Root node candidate from where to start measuring
• ScrollThumbState
• Size
• SliderStatus
  Describes the current status of the Slider.
• SwitchStatus
  Describes the current status of the Switch.
• TemplateAttribute
  An attribute of the TemplateNode, created at compile time
• TemplateNode
  A statically known node in a layout.
• TextEvent
  Events for TextEditor
• Transition
  Configure a Transition animation.
• TransitionAnimation
• TransitionState
  Stores the current state for a Transition.
• UniformValue
  Uniform value to be passed to a Shader.
• UseFutureState
• UsePlatformError

Constants

• DARK_THEME
• LIGHT_THEME

Traits

• AreaModel
• DOMAdapter
• Default
  A trait for giving a type a useful default value.
• Dep
• IntoAttributeValue
  A value that can be converted into an attribute value
• IntoDynNode
  A trait that allows various items to be converted into a dynamic node for the rsx macro
• LayoutMeasurer
• 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 the Properties trait automatically as guarantee that your memoization strategy is safe.
• Scaled
• TextEditor
  Common trait for editable texts
• Throw
  A trait to allow results to be thrown upwards to the nearest Error Boundary
• UseFutureDep

Functions

• Accordion
  Accordion component.
• AccordionBody
  AccordionBody component.
• AccordionSummary
  AccordionSummary component.
• ArrowIcon
• Body
  Body component.
• Button
  Button component.
• Canvas
  Draw anything inside of this canvas.
• CursorArea
  CursorArea component.
• DragProvider
  Provide a common place for DragZones and DropZones to exchange their data.
• DragZone
  Make the inner children draggable to other DropZone.
• DropZone
  Elements from DragZones can be dropped here.
• Dropdown
  Dropdown component.
• DropdownItem
  DropdownItem component.
• ExternalLink
  Link for external locations, e.g websites.
• Fragment
  Create inline fragments using Component syntax.
• GestureArea
  GestureArea component.
• Graph
  Graph component.
• Input
  Input component.
• Loader
  Loader component.
• NetworkImage
  NetworkImage component.
• ProgressBar
  ProgressBar component.
• ScrollBar
• ScrollThumb
• ScrollView
  ScrollView component.
• Slider
  Controlled Slider component.
• Switch
  Controlled Switch component.
• Table
  Table component.
• TableBody
  TableBody component.
• TableCell
  TableCell component.
• TableHead
  TableHead component.
• TableRow
  TableRow component.
• ThemeProvider
  Provides a Theme for all its children.
• Tooltip
  Tooltip component
• VirtualScrollView
  VirtualScrollView component.
• bytes_to_data
  Transform some bytes (e.g: raw image, raw svg) into attribute data
• consume_context
  Consume context from the current scope
• consume_context_from_scope
  Consume context from the current scope
• current_scope_id
  Get the current scope id
• 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.
• get_align_axis
• has_context
  Check if the current scope has a context
• manage_key_event
• provide_context
  Provide context to the current scope
• provide_context_to_scope
  Provide context to the the given scope
• provide_root_context
  Provide a context to the root scope
• push_future
  Pushes the future onto the poll queue to be polled after the component renders.
• remove_future
  Informs the scheduler that this task is no longer needed and should be removed.
• run_app
  Run the app
• 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_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
• suspend
  Suspends the current component
• throw
  Throw an error into the nearest error boundary
• use_animation
  Run animations.
• use_animation_transition
  Run a group of animated transitions.
• use_callback
• use_canvas
  Register a rendering hook to gain access to the Canvas.
• use_const
  Store constant state between component renders.
• 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
• use_editable
  Create a virtual text editor with it’s own cursor and rope.
• use_effect
  A hook that provides a future that executes after the hooks have been applied.
• use_focus
  Create a focus manager for a node.
• use_future
  A future that resolves to a value.
• use_get_theme
  Subscribe to Theme changes, default theme will be used if there is no provided Theme.
• use_init_accessibility
  Sync both the Focus shared state and the platform accessibility focus
• use_init_default_theme
  Provide the default Theme.
• use_init_focus
  Create a focus provider.
• use_init_theme
  Provide a custom Theme.
• use_memo
  A hook that provides a callback that executes if the dependencies change. This is useful to avoid running computation-expensive calculations even when the data doesn’t change.
• use_node
  Subscribe to a Node layout changes.
• use_node_ref
  Silently read the latest layout from a Node.
• use_on_create
  A hook that runs a future when the component is mounted.
• use_on_destroy
  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_on_unmountDeprecated
• use_platform
• use_ref
  use_ref is a key foundational hook for storing state in Dioxus.
• use_root_context
• use_shared_state
  This hook provides some relatively light ergonomics around shared state.
• use_shared_state_provider
  Provide some state for components down the hierarchy to consume without having to drill props. See use_shared_state to consume the state
• use_state
  Store state between component renders.
• use_theme
  Subscribe to Theme changes.

Type Aliases

• Area
• ClickNotifier
• Component
  A Component is a function that takes a Scope and returns an Element.
• CursorPoint
• EditorState
• Element
  An Element is a possibly-none VNode created by calling render on Scope or ScopeState.
• FocusId
• FontsConfig
• HoveredNode
• KeyboardEvent
• Length
• MouseEvent
• Point2D
• PointerEvent
• Scope
  A wrapper around the Scoped object that contains a reference to the ScopeState and properties for a given component.
• Size2D
• TouchEvent
• WheelEvent
• WindowBuilderHook
• WindowCallback

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.

Derive Macros

• Default
  Derive macro generating an impl of the trait Default.
• Props