Struct Switch 

pub struct Switch { /* private fields */ }

Toggle between true and false.

Commonly used for enabled/disabled scenarios.

Example: light/dark theme.

fn app() -> impl IntoElement {
    let mut toggled = use_state(|| false);

    Switch::new()
        .toggled(toggled())
        .on_toggle(move |_| toggled.toggle())
}

Preview

Toggled	Not Toggled

Implementations

impl Switch

pub fn new() -> Self

pub fn toggled(self, toggled: impl Into<Readable<bool>>) -> Self

pub fn on_toggle(self, on_toggle: impl Into<EventHandler<()>>) -> Self

pub fn enabled(self, enabled: impl Into<bool>) -> Self

pub fn layout_variant( self, layout_variant: impl Into<SwitchLayoutVariant>, ) -> Self

pub fn theme_colors(self, theme: SwitchColorsThemePartial) -> Self

pub fn theme_layout(self, theme: SwitchLayoutThemePartial) -> Self

pub fn expanded(self) -> Self

Shortcut for Self::layout_variant and SwitchLayoutVariant::Expanded.

pub fn cursor_icon(self, cursor_icon: impl Into<CursorIcon>) -> Self

Override the cursor icon shown when hovering over this component while enabled.

Trait Implementations

impl Clone for Switch

fn clone(&self) -> Switch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Switch

fn render(self: &Switch) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl Default for Switch

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for Switch

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

where Self: 'static,

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists. The key is scoped to the element’s type, so the same value used on different element or component types never collides.

impl PartialEq for Switch

fn eq(&self, other: &Switch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Switch

impl SwitchColorsThemePartialExt for Switch

fn background(self, background: impl Into<Color>) -> Self

fn thumb_background(self, thumb_background: impl Into<Color>) -> Self

fn toggled_background(self, toggled_background: impl Into<Color>) -> Self

fn toggled_thumb_background( self, toggled_thumb_background: impl Into<Color>, ) -> Self

fn focus_border_fill(self, focus_border_fill: impl Into<Color>) -> Self

impl SwitchLayoutThemePartialExt for Switch

fn margin(self, margin: impl Into<Gaps>) -> Self

fn width(self, width: f32) -> Self

fn height(self, height: f32) -> Self

fn padding(self, padding: f32) -> Self

fn thumb_size(self, thumb_size: f32) -> Self

fn toggled_thumb_size(self, toggled_thumb_size: f32) -> Self

fn pressed_thumb_size_offset(self, pressed_thumb_size_offset: f32) -> Self

fn thumb_offset(self, thumb_offset: f32) -> Self

fn toggled_thumb_offset(self, toggled_thumb_offset: f32) -> Self