Struct TreeViewRef 

pub struct TreeViewRef<'a, 'b, T> { /* private fields */ }

Tree view widget that borrows nodes instead of owning them.

This is useful when you want to avoid cloning the tree on every render frame. Unlike TreeView which takes ownership of nodes, TreeViewRef borrows them, allowing the original data to remain in place after rendering.

Type Parameters

• 'a - Lifetime for borrowed UI elements.
• 'b - Lifetime for borrowed tree nodes.
• T - The type of data stored in tree nodes.

Example

use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Root")];
let tree = TreeViewRef::new(&nodes)
    .render_fn(|data, state| {
        ratatui::text::Line::from(*data)
    });

Implementations

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

pub fn new(nodes: &'b [TreeNode<T>]) -> Self

Creates a new tree view with a reference to nodes (avoids cloning).

Arguments

• nodes - A reference to the root nodes of the tree.

Returns

A new TreeViewRef with default settings.

Example

use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes);

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

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

Sets the block to wrap the tree.

Arguments

• block - The block to wrap the tree view.

Returns

Self for method chaining.

Example

use ratatui::widgets::{Block, Borders};
use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .block(Block::default().borders(Borders::ALL).title("Tree"));

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

pub fn filter_fn<F>(self, _f: F) -> Self

where F: Fn(&T, &Option<String>) -> bool + 'a,

Sets a filter function for filtering nodes based on the filter text.

The function receives the node data and the current filter text, and returns true if the node should be visible.

Note: This method is currently a no-op for API compatibility. Filtering is typically handled externally via get_visible_paths_filtered.

Arguments

• f - A function that takes node data and filter, returns true if matches.

Returns

Self for method chaining.

Example

use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef, helpers::matches_filter};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .filter_fn(|data, filter| matches_filter(data, filter));

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

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

Sets the highlight style for selected rows (full-width background).

Arguments

• style - The style to apply to selected rows.

Returns

Self for method chaining.

Example

use ratatui::style::{Color, Style};
use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .highlight_style(Style::default().bg(Color::Blue));

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

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

Sets the style for expand/collapse icons.

Arguments

• style - The style to apply to icons.

Returns

Self for method chaining.

Example

use ratatui::style::{Color, Style};
use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .icon_style(Style::default().fg(Color::Yellow));

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

pub fn icons(self, expand: &'a str, collapse: &'a str) -> Self

Sets custom expand/collapse icons.

Arguments

• expand - The icon to show for collapsed nodes.
• collapse - The icon to show for expanded nodes.

Returns

Self for method chaining.

Example

use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .icons("+", "-");

impl<'a, 'b, T> TreeViewRef<'a, 'b, T>

pub fn render_fn<F>(self, f: F) -> Self

where F: Fn(&T, &NodeState) -> Line<'a> + 'a,

Sets the render function for nodes.

Arguments

• f - A function that takes node data and state, returns a Line.

Returns

Self for method chaining.

Example

use ratatui::text::Line;
use ratatui_toolkit::tree_view::{TreeNode, TreeViewRef};

let nodes = vec![TreeNode::new("Item")];
let tree = TreeViewRef::new(&nodes)
    .render_fn(|data, state| {
        if state.is_selected {
            Line::from(format!("> {}", data))
        } else {
            Line::from(*data)
        }
    });

Trait Implementations

impl<'a, 'b, T> StatefulWidget for TreeViewRef<'a, 'b, T>

type State = TreeViewState

State associated with the stateful widget.

fn render(self, 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.