Struct Checkbox 

pub struct Checkbox {
    pub id: Option<NodeId>,
    pub checked: bool,
    pub on_toggle: Option<ActionEnvelope>,
    pub label: Option<String>,
}

A boolean toggle with a square check indicator and optional label.

When pressed, the on_toggle action is dispatched. The application is responsible for toggling checked in the corresponding reducer.

Example

let on_toggle = ctx.bind(ToggleAgree, handle_toggle as fn(&mut S, ToggleAgree));

Checkbox {
    checked: view.state.agreed,
    on_toggle: Some(on_toggle),
    label: Some("I agree to the terms".into()),
    ..Default::default()
}

Fields

id: Option<NodeId>

Explicit node identity.

checked: bool

Current checked state.

on_toggle: Option<ActionEnvelope>

Action dispatched when the checkbox is tapped.

label: Option<String>

Optional text label rendered next to the indicator.

Implementations

impl Checkbox

pub fn into_node(self) -> Node

Trait Implementations

impl Clone for Checkbox

fn clone(&self) -> Checkbox

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Checkbox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Checkbox

fn default() -> Checkbox

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Checkbox

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Checkbox> for Node

fn from(w: Checkbox) -> Self

Converts to this type from the input type.

impl Lower for Checkbox

fn lower(&self, cx: &mut LoweringContext<'_>) -> NodeId

Lower this widget into the IR, returning the root node id.

impl Serialize for Checkbox

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: AppState> Widget<S> for Checkbox

fn build(&self, _ctx: &mut BuildCtx<S>, _view: &View<'_, S>) -> Node

Build the widget’s node tree.