Struct Tree 

pub struct Tree<'a, T>
where
    T: ToText + Clone + Default + Display + Hash + PartialEq + Eq,
{ /* private fields */ }

A Tree which can be rendered.

Example

let mut state = TreeState::default();

let item = TreeItem::new_leaf("leaf");
let items = vec![item];

terminal.draw(|frame| {
    let area = frame.area();

    let tree_widget = Tree::new(&items)
        .expect("all item identifiers are unique")
        .block(Block::bordered().title("Tree Widget"));

    frame.render_stateful_widget(tree_widget, area, &mut state);
})?;

Implementations

impl<'a, T> Tree<'a, T>

where T: ToText + Clone + Default + Display + Hash + PartialEq + Eq,

pub fn new(items: &'a [TreeItem<T>]) -> Result<Self>

Create a new Tree.

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. It’s there to test and experiment with what’s 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_no_children_symbol(self, symbol: &'a str) -> Self

Trait Implementations

impl<'a, T> Clone for Tree<'a, T>

where T: ToText + Clone + Default + Display + Hash + PartialEq + Eq + Clone,

fn clone(&self) -> Tree<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Tree<'a, T>

where T: ToText + Clone + Default + Display + Hash + PartialEq + Eq + Debug,

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

Formats the value using the given formatter.

impl<'a, T> StatefulWidget for Tree<'a, T>

where T: ToText + Clone + Default + Display + Hash + PartialEq + Eq,

type State = TreeState

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.

impl<'a, T> Widget for Tree<'a, T>

where T: ToText + Clone + Default + Display + Hash + PartialEq + Eq,

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.