Trait sycamore::component::Prop

pub trait Prop {
    type Builder;

    fn builder() -> Self::Builder;
}

A trait that is implemented automatically by the Prop derive macro.

This is used when constructing components in the view! macro.

Example

Deriving an implementation and using the builder to construct an instance of the struct:

#[derive(Prop)]
struct ButtonProps {
    color: String,
    disabled: bool,
}

let builder = <ButtonProps as Prop>::builder();
let button_props = builder.color("red".to_string()).disabled(false).build();

Required Associated Types

type Builder

The type of the builder. This allows getting the builder type when the name is unknown (e.g. in a macro).

Required Methods

fn builder() -> Self::Builder

Returns the builder for the type. The builder should be automatically generated using the Prop derive macro.

Implementors

impl<'a, G> Prop for PortalProps<'a, G>where
    G: GenericNode,

type Builder = PortalPropsBuilder<'a, ((), ()), G>

impl<'a, G: GenericNode> Prop for SuspenseProps<'a, G>

type Builder = SuspensePropsBuilder<'a, ((), ()), G>

impl<'a, G: GenericNode> Prop for NoHydrateProps<'a, G>

type Builder = NoHydratePropsBuilder<'a, ((),), G>

impl<'a, G: GenericNode> Prop for NoSsrProps<'a, G>

type Builder = NoSsrPropsBuilder<'a, ((),), G>

impl<'a, G: GenericNode, T, F> Prop for IndexedProps<'a, G, T, F>where
    F: Fn(BoundedScope<'_, 'a>, T) -> View<G> + 'a,

type Builder = IndexedPropsBuilder<'a, ((), ()), G, T, F>

impl<'a, T, F, G: GenericNode, K, Key> Prop for KeyedProps<'a, T, F, G, K, Key>where
    F: Fn(BoundedScope<'_, 'a>, T) -> View<G> + 'a,
    K: Fn(&T) -> Key + 'a,
    Key: Clone + Hash + Eq,
    T: Clone + PartialEq,

type Builder = KeyedPropsBuilder<'a, ((), (), ()), T, F, G, K, Key>