Struct Tree

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

A Tree which can be rendered.

The generic argument Identifier is used to keep the state like the currently selected or opened TreeItems in the TreeState. For more information see TreeItem.

Example

let mut state = TreeState::default();

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

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

    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, Identifier> Tree<'a, Identifier>

where Identifier: Clone + PartialEq + Eq + Hash,

pub fn new(items: &'a [TreeItem<'a, Identifier>]) -> 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. 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_no_children_symbol(self, symbol: &'a str) -> Self

Trait Implementations

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

fn clone(&self) -> Tree<'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 Tree<'a, Identifier>

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

Formats the value using the given formatter.

impl<Identifier> StatefulWidget for Tree<'_, Identifier>

where Identifier: Clone + PartialEq + Eq + Hash,

type State = TreeState<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.

impl<Identifier> Widget for Tree<'_, Identifier>

where Identifier: Clone + Eq + Hash,

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.