Struct CheckBox 

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

CheckBox widget.

A toggleable checkbox with a label that supports focus styling and mouse click regions.

Implementations

impl<'a> CheckBox<'a>

pub fn new(label: &'a str, state: &'a CheckBoxState) -> Self

Create a new checkbox.

Arguments

• label - The text label displayed next to the checkbox
• state - Reference to the checkbox state

pub fn style(self, style: CheckBoxStyle) -> Self

Set the checkbox style.

pub fn focus_id(self, id: FocusId) -> Self

Set the focus ID.

pub fn width(&self) -> u16

Calculate width needed for this checkbox.

pub fn render_stateful( self, area: Rect, buf: &mut Buffer, ) -> ClickRegion<CheckBoxAction>

Render the checkbox and return the click region.

Use this method when you need to track click regions for mouse handling.

Trait Implementations

impl Widget for CheckBox<'_>

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.