Struct Switch 

pub struct Switch;

An on/off toggle switch component.

This component provides a boolean on/off input that can be toggled via keyboard when focused. The switch emits SwitchOutput::Toggled, SwitchOutput::On, or SwitchOutput::Off messages when toggled.

Keyboard Activation

When focused, Enter or Space toggles the switch state.

Visual States

• Off: ( ) OFF
• On: (*) ON with success/green coloring
• Focused: Yellow/focused text
• Disabled: Dark gray text, doesn’t respond to toggle
• With label: Label (*) ON

Example

use envision::component::{Switch, SwitchMessage, SwitchOutput, SwitchState, Component};

let mut state = SwitchState::new();

// Toggle the switch on
let output = Switch::update(&mut state, SwitchMessage::Toggle);
assert_eq!(output, Some(SwitchOutput::On));
assert!(state.is_on());

Trait Implementations

impl Component for Switch

type State = SwitchState

The component’s internal state type.

type Message = SwitchMessage

Messages this component can receive.

type Output = SwitchOutput

Messages this component can emit to its parent.

fn init() -> Self::State

Initialize the component state.

fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output>

Update component state based on a message.

fn handle_event( _state: &Self::State, event: &Event, ctx: &EventContext, ) -> Option<Self::Message>

Maps an input event to a component message.

fn view(state: &Self::State, ctx: &mut RenderContext<'_, '_>)

Render the component to the given area.

fn traced_view(state: &Self::State, ctx: &mut RenderContext<'_, '_>)

Renders the component with optional tracing instrumentation.

fn dispatch_event( state: &mut Self::State, event: &Event, ctx: &EventContext, ) -> Option<Self::Output>

Dispatches an event by mapping it to a message and updating state.

impl Toggleable for Switch

fn is_visible(state: &Self::State) -> bool

Returns true if this component is currently visible.

fn set_visible(state: &mut Self::State, visible: bool)

Sets the visibility of this component.

fn toggle(state: &mut Self::State)

Toggles the visibility of this component.

fn show(state: &mut Self::State)

Shows this component.

fn hide(state: &mut Self::State)

Hides this component.