Module freya::prelude

source ·
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 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
  • import_image
    Generate a Dioxus component rendering the specified image.
  • import_svg
    Generate a Dioxus component rendering the specified SVG.
  • 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§

Enums§

Constants§

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
  • ItemPath
    Abstract the path matching.
  • 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
  • SizeModel
  • 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§

Type Aliases§

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