Struct CheckTree 

pub struct CheckTree<'a, Identifier> { /* private fields */ }

A CheckTree which can be rendered.

The generic argument Identifier is used to keep the state like the currently selected or opened CheckTreeItems in the CheckTreeState. For more information see CheckTreeItem.

This differs from the tui_tree_widget crate’s Tree in that it allows for checkboxes to be rendered next to each leaf item. This is useful for creating a tree of items that can be selected.

Implementations

impl<'a, Identifier> CheckTree<'a, Identifier>

where Identifier: Clone + PartialEq + Eq + Hash,

pub fn new(items: &'a [CheckTreeItem<'a, Identifier>]) -> Result<Self, Error>

Create a new CheckTree.

Errors

Errors when there are duplicate identifiers in the children.

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

pub const fn experimental_scrollbar( self, scrollbar: Option<Scrollbar<'a>>, ) -> Self

Show the scrollbar when rendering this widget.

Experimental: Can change on any release without any additional notice. Its there to test and experiment with whats possible with scrolling widgets. Also see https://github.com/ratatui-org/ratatui/issues/174

pub const fn style(self, style: Style) -> Self

pub const fn highlight_style(self, style: Style) -> Self

pub const fn highlight_symbol(self, highlight_symbol: &'a str) -> Self

pub const fn node_closed_symbol(self, symbol: &'a str) -> Self

pub const fn node_open_symbol(self, symbol: &'a str) -> Self

pub const fn node_checked_symbol(self, symbol: &'a str) -> Self

pub const fn node_unchecked_symbol(self, symbol: &'a str) -> Self

Trait Implementations

impl<'a, Identifier: Clone> Clone for CheckTree<'a, Identifier>

fn clone(&self) -> CheckTree<'a, Identifier>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, Identifier: Debug> Debug for CheckTree<'a, Identifier>

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

Formats the value using the given formatter.

impl<'a, Identifier: 'a + Clone + PartialEq + Eq + Hash> StatefulWidget for CheckTree<'a, Identifier>

type State = CheckTreeState<Identifier>

State associated with the stateful widget.

fn render(self, full_area: Rect, buf: &mut Buffer, state: &mut Self::State)

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