Struct MaterialSwitch 

pub struct MaterialSwitch<'a> { /* private fields */ }

Material Design switch component following Material Design 3 specifications

Switches toggle the state of a single item on or off. They are the preferred way to adjust settings on mobile and should be used instead of checkboxes in most cases.

Usage Examples

let mut wifi_enabled = false;
let mut bluetooth_enabled = true;

// Basic switch
ui.add(MaterialSwitch::new(&mut wifi_enabled));

// Switch with label text
ui.add(MaterialSwitch::new(&mut bluetooth_enabled)
    .text("Enable Bluetooth"));

// Disabled switch
let mut disabled_option = false;
ui.add(MaterialSwitch::new(&mut disabled_option)
    .text("Unavailable option")
    .enabled(false));

Material Design Spec (Material 3)

• Track width: 52dp, height: 32dp
• Thumb diameter: 24dp when on, 16dp when off, 28dp when pressed
• Corner radius: 16dp (fully rounded)
• Touch target: 48x48dp minimum
• Colors: Primary when on, surfaceContainerHighest when off
• Track outline: 2dp when off, transparent when on
• Icons: 16dp, displayed on thumb
• Animation: 300ms cubic-bezier transition

Implementations

impl<'a> MaterialSwitch<'a>

pub fn new(selected: &'a mut bool) -> Self

Create a new Material Design switch

Parameters

• selected: Mutable reference to boolean state representing on/off

Returns

A new MaterialSwitch instance with default settings

pub fn text(self, text: impl Into<String>) -> Self

Set optional text label for the switch

The text will be displayed to the right of the switch component.

Parameters

• text: Label text to display next to the switch

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

Set whether the switch is enabled or disabled

Disabled switches cannot be interacted with and are visually dimmed.

Parameters

• enabled: True for interactive, false for disabled

pub fn selected_icon(self, icon: char) -> Self

Set an icon to display on the thumb when the switch is selected (on)

Parameters

• icon: Character representing a Material icon to display on selected thumb

pub fn unselected_icon(self, icon: char) -> Self

Set an icon to display on the thumb when the switch is unselected (off)

Parameters

• icon: Character representing a Material icon to display on unselected thumb

pub fn with_icons(self, selected: char, unselected: char) -> Self

Set icons for both selected and unselected states

Parameters

• selected: Character representing a Material icon to display when on
• unselected: Character representing a Material icon to display when off

pub fn show_track_outline(self, show: bool) -> Self

Set whether to show track outline (Material 3 style)

Parameters

• show: True to show outline when off, false for no outline

Trait Implementations

impl<'a> Widget for MaterialSwitch<'a>

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.