Struct ToggleSwitch

pub struct ToggleSwitch<'text> { /* private fields */ }

👎Deprecated: Use tui-framework-experiment instead

A toggle switch widget

Displays a switch that can be toggled on or off

Examples

use ratatui::widgets::Widget;
use ratatui_widgets::toggle_switch::{ToggleSwitch, State};

let toggle_switch = ToggleSwitch::new("Toggle me", State::Off);
frame.render_widget(toggle_switch, frame.area());

Implementations

impl<'text> ToggleSwitch<'text>

pub fn new<T: Into<Text<'text>>>(text: T, default_state: State) -> Self

👎Deprecated: Use tui-framework-experiment instead

pub fn with_theme(self, theme: Theme) -> Self

👎Deprecated: Use tui-framework-experiment instead

impl ToggleSwitch<'_>

pub fn toggle_state(&mut self)

👎Deprecated: Use tui-framework-experiment instead

pub fn toggle_on(&mut self)

👎Deprecated: Use tui-framework-experiment instead

pub fn toggle_off(&mut self)

👎Deprecated: Use tui-framework-experiment instead

pub fn focus(&mut self)

👎Deprecated: Use tui-framework-experiment instead

pub fn blur(&mut self)

👎Deprecated: Use tui-framework-experiment instead

Trait Implementations

impl<'text> Clone for ToggleSwitch<'text>

fn clone(&self) -> ToggleSwitch<'text>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'text> Debug for ToggleSwitch<'text>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EventHandler for ToggleSwitch<'_>

fn handle_key(&mut self, key_event: KeyPressedEvent)

👎Deprecated: Use tui-framework-experiment instead

fn handle_event(&mut self, event: Event)

👎Deprecated: Use tui-framework-experiment instead

fn handle_mouse(&mut self, event: MouseEvent)

👎Deprecated: Use tui-framework-experiment instead

impl Widget for &ToggleSwitch<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.