Toggle

waterui::component::toggle

Struct Toggle

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

Expand description

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>) -> Toggle

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

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

Sets the label for the toggle.

Trait Implementations§

impl ConfigurableView for Toggle

type Config = ToggleConfig

The configuration type associated with this view. Read more

fn config(self) -> <Toggle as ConfigurableView>::Config

Returns the configuration for this view. Read more

impl From<ToggleConfig> for Toggle

fn from(value: ToggleConfig) -> Toggle

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. Read more

Auto Trait Implementations§

impl Freeze for Toggle

impl !RefUnwindSafe for Toggle

impl !Send for Toggle

impl !Sync for Toggle

impl Unpin for Toggle

impl !UnwindSafe for Toggle

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> IdentifiableExt for T

fn use_id<F, Id>(self, f: F) -> UseId<Self, F>
where F: Fn(&Self) -> Id, Id: Ord + Hash,

Wraps the value in a UseId with the provided identification function.

fn self_id(self) -> SelfId<Self>

Wraps the value in a SelfId, making the value serve as its own identifier.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<V> IntoView for V
where V: View,

type Output = V

The resulting View type after conversion.

fn into_view(self, _env: &Environment) -> <V as IntoView>::Output

Converts the implementing type into a View. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<V> ViewExt for V
where V: View,

fn metadata<T: MetadataKey>(self, metadata: T) -> Metadata<T>

Attaches metadata to a view. Read more

fn with<T: 'static>(self, value: T) -> With<Self, T>

Associates a value with this view in the environment.

fn title(self, title: impl Into<Text>) -> NavigationView

Sets this view as the content of a navigation view with the specified title. Read more

fn focused<T: 'static + Eq + Clone>( self, value: &Binding<Option<T>>, equals: T, ) -> Metadata<Focused>

Marks this view as focused when the binding matches the specified value. Read more

fn on_change<C, F>(self, source: &C, handler: F) -> OnChange<Self, C::Guard>
where C: Signal, C::Output: PartialEq + Clone, F: Fn(C::Output) + 'static,

Monitors a signal for changes and triggers a handler when the signal’s value changes. Read more

fn task<Fut>(self, task: Fut) -> Metadata<Retain>
where Fut: Future<Output = ()> + 'static,

Spawns an asynchronous task tied to the lifecycle of this view. Read more

fn anyview(self) -> AnyView

Converts this view to an AnyView type-erased container.

fn background(self, background: impl Into<Background>) -> Metadata<Background>

Sets the background of this view. Read more

fn foreground( self, color: impl IntoComputed<Color>, ) -> Metadata<ForegroundColor>

Sets the foreground color of this view. Read more

fn overlay<V>(self, overlay: V) -> Overlay<Self, V>

Adds an overlay to this view. Read more

fn event<H: 'static>( self, event: Event, handler: impl HandlerFnOnce<H, ()> + 'static, ) -> Metadata<OnEvent>

Adds an event handler for the specified event. Read more

fn on_disappear<H: 'static>( self, handler: impl HandlerFnOnce<H, ()> + 'static, ) -> Metadata<OnEvent>

Adds a handler that triggers when the view disappears. Read more

fn on_appear<H: 'static>( self, handler: impl HandlerFnOnce<H, ()> + 'static, ) -> Metadata<OnEvent>

Adds a handler that triggers when the view appears. Read more

fn badge(self, value: impl IntoComputed<i32>) -> Badge

Adds a badge to this view. Read more

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

Fixes this view’s width to the provided value.

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

Fixes this view’s height to the provided value.

fn min_width(self, width: f32) -> Frame

Applies a minimum width constraint.

fn max_width(self, width: f32) -> Frame

Applies a maximum width constraint.

fn min_height(self, height: f32) -> Frame

Applies a minimum height constraint.

fn max_height(self, height: f32) -> Frame

Applies a maximum height constraint.

fn size(self, width: f32, height: f32) -> Frame

Fixes both width and height simultaneously.

fn min_size(self, width: f32, height: f32) -> Frame

Applies minimum constraints on both axes.

fn max_size(self, width: f32, height: f32) -> Frame

Applies maximum constraints on both axes.

fn alignment(self, alignment: Alignment) -> Frame

Aligns this view within its frame using the provided alignment.

fn padding_with(self, edge: impl Into<EdgeInsets>) -> Padding

Adds padding to this view with custom edge insets. Read more

fn padding(self) -> Padding

Adds default padding to this view. Read more

fn secure(self) -> Metadata<Secure>

Marks this view as secure. Read more

fn tag<T>(self, tag: T) -> TaggedView<T, Self>

Tags this view with a custom tag for identification. Read more

fn a11y_label( self, label: impl Into<Str>, ) -> IgnorableMetadata<AccessibilityLabel>

Sets the accessibility label for this view. Read more

fn a11y_role( self, role: AccessibilityRole, ) -> IgnorableMetadata<AccessibilityRole>

Sets the accessibility role for this view. Read more

fn gesture<P: 'static>( self, gesture: impl Into<Gesture>, action: impl HandlerFn<P, ()> + 'static, ) -> Metadata<GestureObserver>

Observes a gesture and executes an action when the gesture is recognized. Read more

fn on_tap<P: 'static>( self, action: impl HandlerFn<P, ()> + 'static, ) -> Metadata<GestureObserver>

Adds a tap gesture recognizer to this view that triggers the specified action. Read more

fn shadow(self, shadow: impl Into<Shadow>) -> Metadata<Shadow>

Applies a shadow effect to this view.

fn ignore_safe_area(self, edges: EdgeSet) -> Metadata<IgnoreSafeArea>

Extends this view’s bounds to ignore safe area insets on the specified edges. Read more

fn install(self, plugin: impl Plugin) -> impl View

Installs a plugin into the environment.

fn retain<T: 'static>(self, value: T) -> Metadata<Retain>

Retains a value for the lifetime of this view. Read more

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more