Struct ToggleButton 

pub struct ToggleButton { /* private fields */ }

A toggle button.

Implementations

impl ToggleButton

pub fn new(state: impl Fn() -> bool + 'static) -> Self

Create new ToggleButton.

When the button is toggled by clicking or dragging the widget, an update will be sent to the ToggleButton::on_toggle handler.

By default this toggle button has a style class of ToggleButtonClass applied with a default style provided.

Examples

// An example using read-write signal
let state = RwSignal::new(true);
let toggle = toggle_button(move || state.get())
    .on_toggle(move |new_state| state.set(new_state));

Reactivity

This function is reactive and will reactively respond to changes.

pub fn new_rw( state: impl SignalGet<bool> + SignalUpdate<bool> + Copy + 'static, ) -> Self

Create new ToggleButton with read-write signal.

Examples

// Create read-write signal that will hold toggle button state
let state = RwSignal::new(false);
let simple = ToggleButton::new_rw(state);

Reactivity

This function will update provided signal on toggle or will be updated if signal changes due to external signal update.

pub fn on_toggle(self, ontoggle: impl Fn(bool) + 'static) -> Self

👎Deprecated:

use .on_event_stop(ToggleChanged::listener(), |_, _|) directly instead

Add an event handler to be run when the button is toggled.

This does not run if the state is changed because of an outside signal.

pub fn toggle_style( self, style: impl Fn(ToggleButtonCustomStyle) -> ToggleButtonCustomStyle + 'static, ) -> Self

Set styles related to ToggleButton:

• handle color
• accent color
• handle inset
• circle radius

Trait Implementations

impl View for ToggleButton

fn id(&self) -> ViewId

fn debug_name(&self) -> Cow<'static, str>

fn view_style(&self) -> Option<Style>

fn update(&mut self, _cx: &mut UpdateCx<'_>, state: Box<dyn Any>)

Use this method to react to changes in view-related state. You will usually send state to this hook manually using the View’s Id handle

fn event(&mut self, cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the target and bubble phases of event propagation.

fn style_pass(&mut self, cx: &mut StyleCx<'_>)

Use this method to style the view’s children.

fn paint(&mut self, cx: &mut PaintCx<'_>)

View-specific implementation. Called during paint traversal for this view. Children are painted automatically by Floem. Views should only paint their own content (backgrounds, borders, custom drawing).

fn view_class(&self) -> Option<StyleClassRef>

fn event_capture(&mut self, _cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the capture phase of event propagation.

fn post_paint(&mut self, cx: &mut PaintCx<'_>)