Struct Checkbox

pub struct Checkbox { /* private fields */ }

A checkbox used to display and toggle a boolean state.

Pressing the checkbox triggers the on_toggle callback.

Examples

Basic checkbox

The checkbox must bound to some boolean data.

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

Checkbox with an action

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

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

Checkbox with a label

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

The Label can be used to trigger the checkbox by assigning the checkbox an id name and using it with the describing modifier on the label.

HStack::new(cx, |cx| {
    Checkbox::new(cx, AppData::value).id("check1");
    Label::new(cx, "Press me").describing("check1");
});

Custom checkbox

The with_icons constructor can be used to create a checkbox with custom icons for both checked and unchecked states.

Checkbox::with_icons(cx, AppData::value, None, Some(ICON_X))
    .on_toggle(|cx| cx.emit(AppEvent::ToggleValue));

Implementations

impl Checkbox

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

Creates a new checkbox.

Examples

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

pub fn with_icons<T>( cx: &mut Context, checked: impl Lens<Target = bool>, icon_default: Option<impl Res<T> + Clone + 'static>, icon_checked: Option<impl Res<T> + Clone + 'static>, ) -> Handle<'_, Checkbox>

where T: AsRef<[u8]> + 'static,

Creates a new checkbox with custom icons for both checked and unchecked states.

Examples

Checkbox::with_icons(cx, AppData::value, None, Some(ICON_X))
    .on_toggle(|cx| cx.emit(AppEvent::ToggleValue));

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

Trait Implementations

impl View for Checkbox

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)