Struct yew_styles::spinner::Spinner

pub struct Spinner { /* fields omitted */ }

Spinner component

Features required

spinner

Example

 use yew::prelude::*;
use yew_styles::spinner::{Spinner, SpinnerType};
use yew_styles::styles::{Palette, Size};

pub struct SpinnerExample;

impl Component for SpinnerExample {
    type Message = ();
    type Properties = ();

    fn create(_props: Self::Properties, _link: ComponentLink<Self>) -> Self {
        Self {}
    }

    fn update(&mut self, _msg: Self::Message) -> ShouldRender {
        false
    }

    fn change(&mut self, _props: Self::Properties) -> ShouldRender {
        false
    }

    fn view(&self) -> Html {
        html! {
            <div>
                <Spinner
                    spinner_type=SpinnerType::Circle
                    spinner_size=Size::Medium
                    spinner_palette=Palette::Info/>
            </div>
        }
    }
}

Trait Implementations

impl Component for Spinner

type Message = ()

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 = Props

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.

pub fn create(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.

pub 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.

pub fn change(&mut self, 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:

pub 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.