Struct TreeViewState 

pub struct TreeViewState {
    pub selected_path: Option<Vec<usize>>,
    pub expanded: HashSet<Vec<usize>>,
    pub offset: usize,
    pub filter: Option<String>,
    pub filter_mode: bool,
}

Tree view state for StatefulWidget pattern.

Tracks the current selection, expanded nodes, scroll offset, and filter state for the tree view.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.select(vec![0, 1]);
state.expand(vec![0]);

Fields

selected_path: Option<Vec<usize>>

Currently selected node path (indices from root)

expanded: HashSet<Vec<usize>>

Set of expanded node paths

offset: usize

Vertical scroll offset

filter: Option<String>

Current filter text

filter_mode: bool

Whether filter mode is active

Implementations

impl TreeViewState

pub fn new() -> Self

Creates a new tree view state with default values.

Returns

A new TreeViewState with no selection, no expanded nodes, and no active filter.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let state = TreeViewState::new();
assert!(state.selected_path.is_none());
assert!(state.expanded.is_empty());

impl TreeViewState

pub fn collapse(&mut self, path: Vec<usize>)

Collapses a node at the given path.

Arguments

• path - The path to the node to collapse.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.expand(vec![0]);
state.collapse(vec![0]);
assert!(!state.is_expanded(&[0]));

impl TreeViewState

pub fn collapse_all(&mut self)

Collapses all nodes in the tree.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.expand(vec![0]);
state.expand(vec![0, 1]);
state.collapse_all();
assert!(state.expanded.is_empty());

impl TreeViewState

pub fn expand(&mut self, path: Vec<usize>)

Expands a node at the given path.

Arguments

• path - The path to the node to expand.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.expand(vec![0]);
assert!(state.is_expanded(&[0]));

impl TreeViewState

pub fn expand_all<T>(&mut self, nodes: &[TreeNode<T>])

Expands all nodes in the tree.

Recursively collects all expandable node paths and adds them to the expanded set.

Arguments

• nodes - The tree nodes to expand.

Example

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

let child = TreeNode::new("Child");
let parent = TreeNode::with_children("Parent", vec![child]);
let nodes = vec![parent];

let mut state = TreeViewState::new();
state.expand_all(&nodes);
assert!(state.is_expanded(&[0]));

impl TreeViewState

pub fn is_expanded(&self, path: &[usize]) -> bool

Checks if a node is expanded.

Arguments

• path - The path to the node to check.

Returns

true if the node is expanded, false otherwise.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
assert!(!state.is_expanded(&[0]));
state.expand(vec![0]);
assert!(state.is_expanded(&[0]));

impl TreeViewState

pub fn toggle_expansion(&mut self, path: Vec<usize>)

Toggles expansion of a node at the given path.

If the node is expanded, it will be collapsed. If the node is collapsed, it will be expanded.

Arguments

• path - The path to the node to toggle.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.toggle_expansion(vec![0]);
assert!(state.is_expanded(&[0]));
state.toggle_expansion(vec![0]);
assert!(!state.is_expanded(&[0]));

impl TreeViewState

pub fn append_to_filter(&mut self, c: char)

Appends a character to the filter text.

Arguments

• c - The character to append.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.enter_filter_mode();
state.append_to_filter('t');
state.append_to_filter('e');
assert_eq!(state.filter, Some("te".to_string()));

impl TreeViewState

pub fn backspace_filter(&mut self)

Removes the last character from the filter text.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.set_filter("test".to_string());
state.backspace_filter();
assert_eq!(state.filter, Some("tes".to_string()));

impl TreeViewState

pub fn clear_filter(&mut self)

Clears the current filter.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.set_filter("test".to_string());
state.clear_filter();
assert!(state.filter.is_none());

impl TreeViewState

pub fn enter_filter_mode(&mut self)

Enters filter mode.

Sets filter_mode to true and initializes the filter to an empty string if not already set.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.enter_filter_mode();
assert!(state.filter_mode);
assert_eq!(state.filter, Some(String::new()));

impl TreeViewState

pub fn exit_filter_mode(&mut self)

Exits filter mode.

Sets filter_mode to false but preserves the current filter text.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.enter_filter_mode();
state.set_filter("test".to_string());
state.exit_filter_mode();
assert!(!state.filter_mode);
assert_eq!(state.filter, Some("test".to_string()));

impl TreeViewState

pub fn filter_text(&self) -> Option<&str>

Gets the current filter text.

Returns

The current filter text, or None if no filter is set.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
assert!(state.filter_text().is_none());
state.set_filter("test".to_string());
assert_eq!(state.filter_text(), Some("test"));

impl TreeViewState

pub fn is_filter_mode(&self) -> bool

Checks if filter mode is active.

Returns

true if filter mode is active, false otherwise.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
assert!(!state.is_filter_mode());
state.enter_filter_mode();
assert!(state.is_filter_mode());

impl TreeViewState

pub fn set_filter(&mut self, filter: String)

Sets the filter text.

Arguments

• filter - The filter text to set.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.set_filter("test".to_string());
assert_eq!(state.filter, Some("test".to_string()));

impl TreeViewState

pub fn clear_selection(&mut self)

Clears the current selection.

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.select(vec![0]);
state.clear_selection();
assert!(state.selected_path.is_none());

impl TreeViewState

pub fn select(&mut self, path: Vec<usize>)

Sets the selected node path.

Arguments

• path - The path to the node to select (indices from root).

Example

use ratatui_toolkit::tree_view::TreeViewState;

let mut state = TreeViewState::new();
state.select(vec![0, 1, 2]);
assert_eq!(state.selected_path, Some(vec![0, 1, 2]));

Trait Implementations

impl Clone for TreeViewState

fn clone(&self) -> TreeViewState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeViewState

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

Formats the value using the given formatter.

impl Default for TreeViewState

fn default() -> TreeViewState

Returns the “default value” for a type.