Struct Switch

pub struct Switch { /* private fields */ }

A Switch used to display and toggle a boolean state.

Clicking on the Switch with the left mouse button triggers the on_toggle callback.

Examples

Basic Switch

The Switch must bound to some boolean data.

Switch::new(cx, AppData::value);

Switch with an action

A Switch can be used to trigger a callback when toggled. Usually this is emitting an event responsible for changing the data the Switch is bound to.

Switch::new(cx, AppData::value).on_toggle(|cx| cx.emit(AppEvent::ToggleValue));

Switch with a label

A Switch is usually used with a label next to it describing what data the Switch is bound to or what the Switch does when pressed. This can be done, for example, by wrapping the Switch in an HStack and adding a Label to it.

HStack::new(cx, |cx| {
    Switch::new(cx, AppData::value);
    Label::new(cx, "Press me");
});

Implementations

impl Switch

pub fn new( cx: &mut Context, checked: impl Lens<Target = bool>, ) -> Handle<'_, Switch>

Creates a new Switch.

Examples

Switch::new(cx, AppData::value);

Trait Implementations

impl View for Switch

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css.

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view.

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>

where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view.

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view.

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)