Struct Checkbox 

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

A widget that displays a checkbox with a label.

A Checkbox can be in a checked or unchecked state. The checkbox is rendered with a symbol (default ☐ for unchecked and ☑ for checked) followed by a label.

The widget can be styled using Checkbox::style which affects both the checkbox symbol and the label. You can also style just the checkbox symbol using Checkbox::checkbox_style or the label using Checkbox::label_style.

You can create a Checkbox using Checkbox::new or Checkbox::default.

Examples

use ratatui::style::{Color, Style, Stylize};
use tui_checkbox::Checkbox;

Checkbox::new("Enable feature", true)
    .style(Style::default().fg(Color::White))
    .checkbox_style(Style::default().fg(Color::Green))
    .label_style(Style::default().fg(Color::Gray));

With a block:

use ratatui::widgets::Block;
use tui_checkbox::Checkbox;

Checkbox::new("Accept terms", false).block(Block::bordered().title("Settings"));

Implementations

impl<'a> Checkbox<'a>

pub fn new<T>(label: T, checked: bool) -> Self

where T: Into<Line<'a>>,

Creates a new Checkbox with the given label and checked state.

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Enable feature", true);

With styled label:

use ratatui::style::Stylize;
use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Enable feature".blue(), false);

pub fn label<T>(self, label: T) -> Self

where T: Into<Line<'a>>,

Sets the label of the checkbox.

The label can be any type that converts into a Line, such as a string or a styled span.

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::default().label("My checkbox");

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

Sets the checked state of the checkbox.

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::default().checked(true);

pub fn block(self, block: Block<'a>) -> Self

Wraps the checkbox with the given block.

Examples

use ratatui::widgets::Block;
use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).block(Block::bordered().title("Settings"));

pub fn style<S: Into<Style>>(self, style: S) -> Self

Sets the base style of the widget.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

This style will be applied to both the checkbox symbol and the label unless overridden by more specific styles.

Examples

use ratatui::style::{Color, Style};
use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).style(Style::default().fg(Color::White));

pub fn checkbox_style<S: Into<Style>>(self, style: S) -> Self

Sets the style of the checkbox symbol.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

This style will be combined with the base style set by Checkbox::style.

Examples

use ratatui::style::{Color, Style};
use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", true).checkbox_style(Style::default().fg(Color::Green));

pub fn label_style<S: Into<Style>>(self, style: S) -> Self

Sets the style of the label text.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

This style will be combined with the base style set by Checkbox::style.

Examples

use ratatui::style::{Color, Style};
use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).label_style(Style::default().fg(Color::Gray));

pub fn checked_symbol<T>(self, symbol: T) -> Self

where T: Into<Cow<'a, str>>,

Sets the symbol to use when the checkbox is checked.

The default is ☑ (U+2611).

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", true).checked_symbol("[X]");

pub fn unchecked_symbol<T>(self, symbol: T) -> Self

where T: Into<Cow<'a, str>>,

Sets the symbol to use when the checkbox is unchecked.

The default is ☐ (U+2610).

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).unchecked_symbol("[ ]");

pub const fn label_position(self, position: LabelPosition) -> Self

Sets the position of the label relative to the checkbox symbol.

The default is LabelPosition::Right.

Examples

use tui_checkbox::{Checkbox, LabelPosition};

let checkbox = Checkbox::new("Option", false).label_position(LabelPosition::Left);

pub const fn horizontal_alignment(self, alignment: HorizontalAlignment) -> Self

Sets the horizontal alignment of the checkbox content within its area.

The default is HorizontalAlignment::Left.

Examples

use tui_checkbox::{Checkbox, HorizontalAlignment};

let checkbox = Checkbox::new("Option", false)
    .horizontal_alignment(HorizontalAlignment::Center);

pub const fn vertical_alignment(self, alignment: VerticalAlignment) -> Self

Sets the vertical alignment of the checkbox content within its area.

The default is VerticalAlignment::Top.

Examples

use tui_checkbox::{Checkbox, VerticalAlignment};

let checkbox = Checkbox::new("Option", false)
    .vertical_alignment(VerticalAlignment::Center);

pub const fn min_width(self, width: u16) -> Self

Sets the minimum width constraint for the checkbox widget.

The default is no minimum width.

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).min_width(20);

pub const fn max_width(self, width: u16) -> Self

Sets the maximum width constraint for the checkbox widget.

The default is no maximum width.

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("Option", false).max_width(40);

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

Enables or disables label text wrapping.

When enabled, the label will wrap to multiple lines if it exceeds the available width. The default is false (no wrapping).

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::new("This is a very long label that should wrap", false)
    .wrap_label(true)
    .max_width(30);

Trait Implementations

impl<'a> Clone for Checkbox<'a>

fn clone(&self) -> Checkbox<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Checkbox<'a>

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

Formats the value using the given formatter.

impl Default for Checkbox<'_>

fn default() -> Self

Returns a default Checkbox widget.

The default widget has:

• Empty label
• Unchecked state
• No block
• Default style for all elements
• Unicode checkbox symbols (☐ and ☑)
• Label position on the right
• Left and top alignment
• No width constraints
• No label wrapping

Examples

use tui_checkbox::Checkbox;

let checkbox = Checkbox::default();

impl<'a> Hash for Checkbox<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Checkbox<'a>

fn eq(&self, other: &Checkbox<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Styled for Checkbox<'_>

type Item = Checkbox<'_>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self::Item

Sets the style of the object.

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.

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.

impl<'a> Eq for Checkbox<'a>

impl<'a> StructuralPartialEq for Checkbox<'a>