Struct UseBoolean 

pub struct UseBoolean {
    pub value: Signal<bool>,
}

A reactive boolean toggle with a caller-chosen initial value.

The existing Toggle type always starts as false, which is the right default for a switch but the wrong one for a dialog that opens already expanded. This type is the same toggle with the initial value chosen by the caller.

The current value is exposed as a Signal<bool> accessed through get_value(). Any html! body that reads toggle.get_value().get() inside its render closure re-renders when the value changes.

Fields

value: Signal<bool>

The current value signal.

Defaults to Signal::create(false) via #[new(skip)]; the hook overwrites it with the requested initial value.

Implementations

impl UseBoolean

Inherent implementation of UseBoolean.

pub fn set_true(&self)

Sets the value to true.

pub fn set_false(&self)

Sets the value to false.

pub fn toggle(&self)

Flips the value: true becomes false, false becomes true.

pub fn set_value(&self, next: bool)

Replaces the value with next.

Arguments

• bool - The new value.

pub fn get(&self) -> bool

Returns the current value as a snapshot.

Returns

• bool - The current value.

impl UseBoolean

pub fn get_value(&self) -> Signal<bool>

pub fn get_mut_value(&mut self) -> &mut Signal<bool>

impl UseBoolean

pub fn new() -> Self

Trait Implementations

impl Clone for UseBoolean

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UseBoolean

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

Formats the value using the given formatter.

impl Default for UseBoolean

fn default() -> Self

Returns the “default value” for a type.