tui_checkbox/symbols.rs
1//! Symbols for checkbox widget
2//!
3//! This module provides predefined checkbox symbols that can be used with the [`Checkbox`] widget.
4//!
5//! [`Checkbox`]: crate::Checkbox
6
7/// Checked checkbox symbol (☑)
8pub const CHECKED: &str = "☑";
9
10/// Unchecked checkbox symbol (☐)
11pub const UNCHECKED: &str = "☐";
12
13/// Alternative checked checkbox symbol with X
14pub const CHECKED_X: &str = "[X]";
15
16/// Alternative unchecked checkbox symbol with space
17pub const UNCHECKED_SPACE: &str = "[ ]";
18
19/// Alternative checked checkbox symbol with asterisk
20pub const CHECKED_ASTERISK: &str = "[*]";
21
22/// Alternative checked checkbox symbol with plus
23///
24/// # Examples
25///
26/// ```
27/// use tui_checkbox::{Checkbox, symbols};
28///
29/// let checkbox = Checkbox::new("Task", true)
30/// .checked_symbol(symbols::CHECKED_PLUS);
31/// ```
32pub const CHECKED_PLUS: &str = "[+]";
33
34/// Alternative unchecked checkbox symbol with minus
35///
36/// # Examples
37///
38/// ```
39/// use tui_checkbox::{Checkbox, symbols};
40///
41/// let checkbox = Checkbox::new("Task", false)
42/// .unchecked_symbol(symbols::UNCHECKED_MINUS);
43/// ```
44pub const UNCHECKED_MINUS: &str = "[-]";
45
46/// Alternative checked checkbox symbol with X in parenthesis
47///
48/// # Examples
49///
50/// ```
51/// use tui_checkbox::{Checkbox, symbols};
52///
53/// let checkbox = Checkbox::new("Task", true)
54/// .checked_symbol(symbols::CHECKED_PARENTHESIS_X)
55/// .unchecked_symbol(symbols::UNCHECKED_PARENTHESIS_O);
56/// ```
57pub const CHECKED_PARENTHESIS_X: &str = "(X)";
58
59/// Alternative unchecked checkbox symbol with O in parenthesis
60///
61/// # Examples
62///
63/// ```
64/// use tui_checkbox::{Checkbox, symbols};
65///
66/// let checkbox = Checkbox::new("Task", false)
67/// .checked_symbol(symbols::CHECKED_PARENTHESIS_X)
68/// .unchecked_symbol(symbols::UNCHECKED_PARENTHESIS_O);
69/// ```
70pub const UNCHECKED_PARENTHESIS_O: &str = "(O)";