Struct tui_tree_widget::Tree

pub struct Tree<'a> { /* 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(|f| {
    let area = f.size();

    let tree_widget = Tree::new(items.clone())
        .block(Block::default().borders(Borders::ALL).title("Tree Widget"));

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

Implementations

impl<'a> Tree<'a>

pub fn new<T>(items: T) -> Selfwhere T: Into<Vec<TreeItem<'a>>>,

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

pub const fn start_corner(self, corner: Corner) -> Self

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> Clone for Tree<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type State = TreeState

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

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

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.