Skip to main content

Toggle

Struct Toggle 

Source
pub struct Toggle { /* private fields */ }
Expand description

A pressable button with on/off state (shadcn/ui Toggle)

§Example

let mut pressed = false;
Toggle::new("Bold")
    .variant(ToggleVariant::Outline)
    .show(ui, &mut pressed);

Implementations§

Source§

impl Toggle

Source

pub fn new(label: impl Into<String>) -> Self

Create a new toggle with the given label

Source

pub fn id(self, id: impl Into<Id>) -> Self

Set ID for state persistence

Source

pub const fn variant(self, variant: ToggleVariant) -> Self

Set the visual variant

Source

pub const fn size(self, size: ToggleSize) -> Self

Set the size

Source

pub const fn disabled(self, disabled: bool) -> Self

Set disabled state

Source

pub const fn content_width(self, width: f32) -> Self

Set explicit content area width for custom content.

When using show_ui, this controls the inner width. If not set, defaults to a square layout (width = height).

Source

pub fn show(self, ui: &mut Ui, pressed: &mut bool) -> ToggleResponse

Show the toggle button

pressed tracks whether the toggle is in the on/off state.

Source

pub fn show_ui( self, ui: &mut Ui, pressed: &mut bool, content: impl FnOnce(&mut Ui, &ContentContext), ) -> ToggleResponse

Show the toggle with custom content instead of a text label.

The closure receives a &mut Ui (with override text color set) and a ContentContext with the state-dependent color and font size.

§Example
let mut pressed = false;
Toggle::new("")
    .variant(ToggleVariant::Outline)
    .show_ui(ui, &mut pressed, |ui, ctx| {
        // Render an icon using ctx.color
    });

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.