Struct Toggle 

pub struct Toggle(/* private fields */);

A control that toggles between on and off states.

Toggle displays a switch with an optional label. It’s commonly used for settings that can be turned on or off.

Layout Behavior

With a label: Toggle expands horizontally to fill available space, placing the label on the left and switch on the right. Without a label: Toggle is content-sized (just the switch).

Examples

// Simple toggle with label
toggle("Wi-Fi", &is_enabled)

// Toggle without label
Toggle::new(&dark_mode)

// In a settings list
vstack((
    toggle("Notifications", &notifications),
    toggle("Sound", &sound),
))

Implementations

impl Toggle

pub fn new(toggle: &Binding<bool>) -> Self

Creates a new Toggle with the specified binding for the toggle state.

pub fn label(self, view: impl View) -> Self

Sets the label for the toggle.

Trait Implementations

impl ConfigurableView for Toggle

type Config = ToggleConfig

The configuration type associated with this view.

fn config(self) -> Self::Config

Returns the configuration for this view.

impl From<ToggleConfig> for Toggle

fn from(value: ToggleConfig) -> Self

Converts to this type from the input type.

impl View for Toggle

fn body(self, env: &Environment) -> impl View

Build this view and return the content.