Module freya::prelude

Useful imports.

Re-exports

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

Modules

• dioxus_elements
• elements
• error
• events
• keyboard
• mouse
• pointer
• touch
• wheel

Macros

• debug_location
• format_args_f
• hot_reload_init
  Start the hot reloading server with the current directory as the root
• 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.
• to_owned
  A helper macro for using hooks and properties in async environements.
• 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 Accordion component.
• AnimationManager
  Manage the lifecyle of an Animation.
• BodyTheme
  Theming properties for the App body.
• 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 Button components.
• CanvasProps
  Canvas component properties.
• 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 DropdownItem components.
• DropdownProps
  Dropdown component properties.
• DropdownTheme
  Theming properties for Dropdown components.
• EditableConfig
  Create a configuration for a UseEditable.
• Event
  A wrapper around some generic data that handles the event’s state
• ExternalLinkProps
  ExternalLink component properties.
• ExternalLinkTheme
  Theming properties for ExternalLink components.
• FontTheme
  Theming properties for Fonts.
• Gaps
• GestureAreaProps
  GestureArea component properties.
• GraphLine
  Data line for the Graph component.
• GraphProps
  Graph component properties.
• Image
• InputProps
  Input component properties.
• KeyboardData
  Data of a Keyboard event.
• LaunchConfig
  Launch configuration.
• LaunchConfigBuilder
  Configuration Builder.
• 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. Currently empty.
• LoaderTheme
  Theming properties for Loader component.
• Measure
• MouseData
  Data of a Mouse event.
• NetworkImageProps
  NetworkImage component properties.
• 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 ProgressBar component.
• 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
• 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
• ScrollThumbProps
• ScrollViewProps
  ScrollView component properties.
• ScrollbarTheme
  Theming properties the Scrollbar components.
• Selector
  Selector state is state that is derived from tracked state
• SliderProps
  Slider component properties.
• SliderTheme
  Theming properties for Slider components.
• SwitchProps
  Switch component properties.
• SwitchTheme
  Theming properties the Switch components.
• 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
  Theming properties for Themes.
• ThemeProviderProps
  ThemeProvider component properties.
• TooltipProps
  Tooltip component properties.
• TooltipTheme
  Theming properties for Tooltip components.
• Torin
• TouchData
  Data of a Touch event.
• Tracked
  Tracked state is state that can drive Selector state
• TrackedMut
  A mutable reference to tracked state
• 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.
• 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

• Alignment
• Animation
  Animation mode and configuration.
• ButtonStatus
  Identifies the current status of the Button.
• CustomAttributeValues
  Group all the custom attribute types
• DirectionMode
• DropdownItemState
  Current status of the DropdownItem.
• DropdownState
  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.
• RootNodeCandidate
  Contains the best Root node candidate from where to start measuring
• Size
• 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
  Dark theme
• LIGHT_THEME
  Light theme

Traits

• BoxModel
• DOMAdapter
• Dep
• IntoAttributeValue
  A value that can be converted into an attribute value
• 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.
• 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.
• 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
• 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.
• manage_key_event
• 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.
• 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_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_unmount
  Creats 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_platform
• use_ref
  use_ref is a key foundational hook for storing state in Dioxus.
• use_root_context
• use_selector
• 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.
• use_tracked_state
  Create a new tracked state. Tracked state is state that can drive Selector state

Type Definitions

• 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
• 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
• WindowCallback

Attribute Macros

• inline_props
  Derive props for a component within the component definition.

Derive Macros

• Props