Struct yew_state::component::wrapper::SharedStateComponent

pub struct SharedStateComponent<C, SCOPE = <<<C as Component>::Properties as SharedState>::Handle as Handle>::Handler> where
    C: Component,
    C::Properties: SharedState + Clone,
    <C::Properties as SharedState>::Handle: WrapperHandle,
    SCOPE: 'static,  { /* fields omitted */ }

Component wrapper for managing messages and state handles.

Wraps any component with properties that implement SharedState:

pub type MyComponent = SharedStateComponent<MyComponentModel>;

A scope may be provided to specify where the state is shared:

// This will only share state with other components using `FooScope`.
pub struct FooScope;
pub type MyComponent = SharedStateComponent<MyComponentModel, FooScope>;

Important

By default StorageHandle and GlobalHandle have different scopes. Though not enforced, components with different handles should not use the same scope.

Trait Implementations

impl<C, SCOPE> Component for SharedStateComponent<C, SCOPE> where
    C: Component,
    C::Properties: SharedState + Clone,
    <C::Properties as SharedState>::Handle: Clone + WrapperHandle, 

type Message = SharedStateComponentMsg<C::Properties>

Messages are used to make Components dynamic and interactive. Simple Component's can declare their Message type to be (). Complex Component's commonly use an enum to declare multiple Message types.

type Properties = C::Properties

Properties are the inputs to a Component and should not mutated within a Component. They are passed to a Component using a JSX-style syntax.

fn create(mut props: Self::Properties, link: ComponentLink<Self>) -> Self

Components are created with their properties as well as a ComponentLink which can be used to send messages and create callbacks for triggering updates.

fn update(&mut self, msg: Self::Message) -> ShouldRender

Components handle messages in their update method and commonly use this method to update their state and (optionally) re-render themselves.

fn change(&mut self, mut props: Self::Properties) -> ShouldRender

When the parent of a Component is re-rendered, it will either be re-created or receive new properties in the change lifecycle method. Component's can choose to re-render if the new properties are different than the previously received properties. Most Component's will use props with a PartialEq impl and will be implemented like this:

fn view(&self) -> Html

Components define their visual layout using a JSX-style syntax through the use of the html! procedural macro. The full guide to using the macro can be found in Yew's documentation.

pub fn rendered(&mut self, _first_render: bool)

The rendered method is called after each time a Component is rendered but before the browser updates the page.

pub fn destroy(&mut self)

The destroy method is called right before a Component is unmounted.