Struct patternfly_yew::components::switch::Switch

pub struct Switch { /* private fields */ }

Switch component

A switch toggles the state of a setting (between on and off). Switches and checkboxes can often be used interchangeably, but the switch provides a more explicit, visible representation on a setting.

See: https://www.patternfly.org/components/switch

Properties

Defined by SwitchProperties.

Trait Implementations

impl Component for Switch

type Message = SwitchMsg

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

The Component’s properties.

fn create(ctx: &Context<Self>) -> Self

Called when component is created.

fn update(&mut self, ctx: &Context<Self>, msg: Self::Message) -> bool

Called when a new message is sent to the component via its scope.

fn changed(&mut self, ctx: &Context<Self>, _: &Self::Properties) -> bool

Called when properties passed to the component change

fn view(&self, ctx: &Context<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.

fn rendered(&mut self, ctx: &Context<Self>, first_render: bool)

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

fn prepare_state(&self) -> Option<String>

Prepares the state during server side rendering.

fn destroy(&mut self, ctx: &Context<Self>)

Called right before a Component is unmounted.