Module freya::prelude

Useful imports.

Re-exports

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

Modules

• dioxus_elements
• file
• 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.
• default_impl
  This macro is used to generate a impl Default block for any type with the function new_maybe_sync that takes a generic T
• define_theme
  Example usage:
• eq_impls
  This macro is used to generate impl PartialEq blocks for any Readable type that takes a generic T
• fmt_impls
  This macro is used to generate impl Display, and impl Debug blocks for any Readable type that takes a generic T
• 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, and impl Eq blocks for any Readable type that takes a generic T
• 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, and impl DivAssign blocks for any Writable type that takes a generic T

Structs

• AbsolutePosition
• 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.
• ActivableRouteContext
• ActivableRouteProps
  Properties for the ActivableRoute component.
• AnimColor
• AnimNum
• ArrowIconProps
• Attribute
  An attribute on a DOM node, such as id="my-thing" or href="https://example.com"
• 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.
• 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.
• CheckboxProps
  Properties for the Checkbox component.
• CheckboxTheme
  Theming properties for the Checkbox component.
• CheckboxThemeWith
  You can use this to change a theme for only one component, with the theme property.
• Config
• Context
• CopyValue
  CopyValue is a wrapper around a value to make the value mutable and Copy.
• Coroutine
• CrossIconProps
• CursorAreaProps
  CursorArea component properties.
• DesktopRenderer
  Desktop renderer for Freya.
• 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.
• EditorHistory
• Effect
  A handle to an effect.
• ErrorBoundary
  A boundary that will capture any errors from child components
• 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.
• FileData
  Data of a Keyboard event.
• 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.
• GlobalMemo
  A signal that can be accessed from anywhere in the application and created in a static
• GlobalSignal
  A signal that can be accessed from anywhere in the application and created in a static
• 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.
• IconTheme
  Theming properties for the Icon component.
• IconThemeWith
  You can use this to change a theme for only one component, with the theme property.
• 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
• LayoutNode
  Cached layout results of a Node
• Line
  A text line from a TextEditor
• LinesIterator
  Iterator over text lines.
• LinkProps
  Properties for the Link component.
• LinkTheme
  Theming properties for the Link component.
• LinkThemeWith
  You can use this to change a theme for only one component, with the theme property.
• 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.
• MappedSignal
  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.
• MenuButtonProps
  Properties for the MenuButton component.
• MenuContainerProps
  Properties for the MenuContainer component.
• MenuContainerTheme
  Theming properties for the MenuContainer component.
• MenuContainerThemeWith
  You can use this to change a theme for only one component, with the theme property.
• MenuItemProps
  Properties for the MenuItem component.
• MenuItemTheme
  Theming properties for the MenuItem component.
• MenuItemThemeWith
  You can use this to change a theme for only one component, with the theme property.
• MenuProps
  Properties for the Menu component.
• Modifiers
  Pressed modifier keys.
• MouseData
  Data of a Mouse event.
• NativeRouterProps
  Properties for the NativeRouter component.
• 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
• 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.
• PlatformInformation
  Information about the platform.
• PointerData
  Data of a Mouse event.
• PopupBackgroundProps
  Properties for the PopupBackground component.
• PopupContentProps
  Properties for the PopupContent component.
• PopupProps
  Properties for the Popup component.
• PopupTheme
  Theming properties for the Popup component.
• PopupThemeWith
  You can use this to change a theme for only one component, with the theme property.
• PopupTitleProps
  Properties for the PopupTitle component.
• 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.
• RadioProps
  Properties for the Radio component.
• RadioTheme
  Theming properties for the Radio component.
• RadioThemeWith
  You can use this to change a theme for only one component, with the theme property.
• ReactiveContext
  A context for signal reads and writes to be directed to
• ReadOnlySignal
  A signal that can only be read from.
• ReadableValueIterator
  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.
• 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 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.
• ScopeState
  A component’s rendered 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.
• SidebarItemProps
  Properties for the SidebarItem component.
• SidebarItemTheme
  Theming properties for the SidebarItem component.
• SidebarItemThemeWith
  You can use this to change a theme for only one component, with the theme property.
• SidebarProps
  Properties for the Sidebar component.
• SidebarTheme
  Theming properties for the Sidebar component.
• SidebarThemeWith
  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.
• SignalData
  The data stored for tracking in a signal.
• 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.
• SnackBarBoxProps
  Properties for the SnackBarBox component.
• SnackBarProps
  Properties for the SnackBar component.
• SnackBarTheme
  Theming properties for the SnackBar component.
• SnackBarThemeWith
  You can use this to change a theme for only one component, with the theme property.
• SubMenuProps
  Properties for the SubMenu component.
• 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.
• SyncStorage
  A thread safe storage. This is slower than the unsync storage, but allows you to share the value between threads.
• 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.
• Task
  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
• TextEvent
  Events for TextEditor
• Theme
• ThemeProviderProps
  ThemeProvider component properties.
• TickIconProps
• Ticker
• TileProps
  Properties for the Tile component.
• TileTheme
  Theming properties for the Tile component.
• TileThemeWith
  You can use this to change a theme for only one component, with the theme property.
• 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.
• 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.
• UnsyncStorage
  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.
• UseCanvasRunner
• UseEditable
  Manage an editable content.
• UseFocus
  Manage the focus operations of given Node
• UseFuture
• UsePlatform
• VNode
  A reference to a template along with any context needed to hydrate it
• VNodeInner
  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
• WritableValueIterator
  An iterator over the values of a Writable<Vec<T>>.
• Write
  A mutable reference to a signal’s value.

Enums

• AccordionStatus
  Indicates the current status of the accordion.
• AlignAxis
• Alignment
• AlignmentDirection
• AnimDirection
  Controls the direction of the animation.
• BorrowError
  An error that can occur when trying to borrow a value.
• BorrowMutError
  An error that can occur when trying to borrow a value mutably.
• ButtonStatus
  Identifies the current status of the Button.
• Code
  Code is the physical position of a key.
• Content
• Cow
  A clone-on-write smart pointer.
• CursorIcon
  Describes the appearance of the (usually mouse) cursor icon.
• CustomAttributeValues
  Group all the custom attribute types
• DirectionMode
• DropdownItemStatus
  Current status of the DropdownItem.
• DropdownStatus
  Current status of the Dropdown.
• DynamicCalculation
• Ease
• EditableEvent
  Events emitted to the UseEditable.
• EditableMode
  How the editable content must behave.
• Force
  Describes the force of a touch event
• Function
• Gesture
  Gesture emitted by the GestureArea component.
• HistoryChange
• ImageStatus
  Image status.
• InputMode
  Enum to declare is Input hidden.
• InputStatus
  Indicates the current status of the Input.
• Key
  Key represents the meaning of a keypress.
• LinkTooltip
• MenuItemStatus
  Indicates the current status of the MenuItem.
• MouseButton
  Describes a button of a mouse controller.
• OnFinish
  What to do once the animation finishes. By default it is Stop
• OrderDirection
• PointerType
  The type of device that triggered a Pointer event.
• 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.
• TileStatus
  Indicates the current status of the Tile.
• TouchPhase
  Describes touch-screen input state.
• UniformValue
  Uniform value to be passed to a Shader.
• UseFutureState
  A signal that represents the state of a future
• UsePlatformError
• UseResourceState
  A signal that represents the state of the resource

Constants

• DARK_THEME
• LIGHT_THEME

Traits

• AnimatedValue
• AnyStorage
  A trait for any storage backing type.
• AreaModel
• ComponentFunction
  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.
• DependencyElement
  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
• 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.
• Readable
  A trait for states that can be read from like crate::Signal, crate::GlobalSignal, or crate::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 a crate::Signal and one that accepts a crate::GlobalSignal, you can create one function that accepts a Readable type.
• ReadableOptionExt
  An extension trait for Readable<Option> that provides some convenience methods.
• ReadableVecExt
  An extension trait for Readable<Vec> that provides some convenience methods.
• Scaled
• Storage
  A trait for a storage backing type. (RefCell, RwLock, etc.)
• SuperFrom
  A enhanced version of the From trait that allows with more flexibility.
• SuperInto
  A enhanced version of the Into trait that allows with more flexibility.
• TextEditor
  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, or crate::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 a crate::Signal and one that accepts a crate::GlobalSignal, you can create one function that accepts a Writable type.
• WritableOptionExt
  An extension trait for Writable<Option> that provides some convenience methods.
• WritableVecExt
  An extension trait for Writable<Vec> that provides some convenience methods.

Functions

• Accordion
  Accordion component.
• AccordionBody
  AccordionBody component.
• AccordionSummary
  AccordionSummary component.
• ActivableRoute
• ArrowIcon
• Body
  Body component.
• Button
  Button component.
• Canvas
  Draw anything inside of this canvas.
• Checkbox
  Controlled Checkbox component.
• CrossIcon
• 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.
• ErrorBoundary
  Create a new error boundary component.
• Fragment
  Create inline fragments using Component syntax.
• GestureArea
  GestureArea component.
• Graph
  Graph component.
• Input
  Input component.
• 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 a Router component.
• Loader
  Loader component.
• Menu
  Menu component.
• MenuButton
• MenuContainer
• MenuItem
  MenuItem component.
• NativeRouter
• NetworkImage
  NetworkImage component.
• Popup
  Popup component.
• PopupBackground
• PopupContent
• PopupTitle
• ProgressBar
  ProgressBar component.
• Radio
  Controlled Radio component.
• ScrollBar
• ScrollThumb
• ScrollView
  ScrollView component.
• Sidebar
  Props
• SidebarItem
  Props
• Slider
  Controlled Slider component.
• SnackBar
  SnackBar component. Use in combination with other components.
• SnackBarBox
• SubMenu
• 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.
• TickIcon
• Tile
  Tile component.
• Tooltip
  Tooltip component
• VirtualScrollView
  VirtualScrollView component.
• apply_value
• 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_owner
  Returns the current owner. This owner will be used to drop any Copy state that is created by the generational-box crate.
• 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.
• 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
• 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_to_data
  Transform some static bytes (e.g: raw image, raw svg) into attribute data
• 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_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_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 use spawn directly. use_future won’t return a value. If you want to return a value from a future, use use_resource instead.
• use_get_theme
  Subscribe to Theme changes, default theme will be used if there is no provided Theme.
• 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_unmountDeprecated
• 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 but use_resource returns a value. See Resource for more details.
• use_root_context
• 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

• AccessibilityIdCounter
• Area
• Component
  A Component is a function that takes Properties and returns an Element.
• CursorPoint
• Element
  An Element is a possibly-none VNode created by calling render on [Scope] or ScopeState.
• EmbeddedFonts
• HoveredNode
• KeyboardEvent
• Length
• MouseEvent
• Point2D
• PointerEvent
• ReadableRef
  A reference to a value that can be read from.
• Size2D
• SyncSignal
  A signal that can safely shared between threads.
• TouchEvent
• WheelEvent
• WindowBuilderHook
• WindowCallback
• WritableRef
  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.

Derive Macros

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