Trait Properties

pub trait Properties:
    Sized
    + Clone
    + 'static {
    type Builder;

    // Required methods
    fn builder() -> Self::Builder;
    fn memoize(&mut self, other: &Self) -> bool;

    // Provided method
    fn into_vcomponent<M>(
        self,
        render_fn: impl ComponentFunction<Self, M>,
    ) -> VComponent
       where M: 'static { ... }
}

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.

Dioxus requires your props to be ’static, Clone, and PartialEq. We use the PartialEq trait to determine if the props have changed when we diff the component.

Example

#[derive(Props, PartialEq, Clone)]
struct MyComponentProps {
    data: String
}

fn MyComponent(props: MyComponentProps) -> Element {
    rsx! {
        div { "Hello {props.data}" }
    }
}

Or even better, derive your entire props struct with the [#[crate::component]] macro:

#[component]
fn MyComponent(data: String) -> Element {
    rsx! {
        div { "Hello {data}" }
    }
}

Required Associated Types

type Builder

The type of the builder for this component. Used to create “in-progress” versions of the props.

Required Methods

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, other: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

Provided Methods

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Properties for ()

type Builder = EmptyBuilder

fn builder() -> <() as Properties>::Builder

fn memoize(&mut self, _other: &()) -> bool

impl Properties for LinkProps

where LinkProps: Clone,

type Builder = LinkPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ())>

fn builder() -> <LinkProps as Properties>::Builder

fn memoize(&mut self, new: &LinkProps) -> bool

impl Properties for MetaProps

where MetaProps: Clone,

type Builder = MetaPropsBuilder<((), (), (), (), ())>

fn builder() -> <MetaProps as Properties>::Builder

fn memoize(&mut self, new: &MetaProps) -> bool

impl Properties for ScriptProps

where ScriptProps: Clone,

type Builder = ScriptPropsBuilder<((), (), (), (), (), (), (), (), (), ())>

fn builder() -> <ScriptProps as Properties>::Builder

fn memoize(&mut self, new: &ScriptProps) -> bool

impl Properties for StyleProps

where StyleProps: Clone,

type Builder = StylePropsBuilder<((), (), (), (), ())>

fn builder() -> <StyleProps as Properties>::Builder

fn memoize(&mut self, new: &StyleProps) -> bool

impl Properties for TitleProps

where TitleProps: Clone,

type Builder = TitlePropsBuilder<((),)>

fn builder() -> <TitleProps as Properties>::Builder

fn memoize(&mut self, new: &TitleProps) -> bool

Implementors

impl Properties for SuspenseBoundaryProps

where SuspenseBoundaryProps: Clone,

type Builder = SuspenseBoundaryPropsBuilder<((), ())>