ratatui-toolkit 0.2.6

DEPRECATED: this crate was renamed to `ratkit`. Please migrate to `ratkit`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! Tree view widget for hierarchical data display.
//!
//! This module provides a complete tree view implementation with:
//! - `TreeNode` - Hierarchical data structure for tree nodes
//! - `NodeState` - State information for rendering nodes
//! - `TreeViewState` - Selection, expansion, and filter state
//! - `TreeView` - The main widget (takes ownership of nodes)
//! - `TreeViewRef` - Widget that borrows nodes (avoids cloning)
//! - `TreeNavigator` - Keyboard navigation with configurable keybindings
//! - `TreeKeyBindings` - Customizable keybindings for navigation
//!
//! # Example
//!
//! ```rust
//! use ratatui_toolkit::tree_view::{TreeNode, TreeView, TreeViewState};
//!
//! let nodes = vec![
//!     TreeNode::with_children("Root", vec![
//!         TreeNode::new("Child 1"),
//!         TreeNode::new("Child 2"),
//!     ]),
//! ];
//!
//! let tree = TreeView::new(nodes)
//!     .render_fn(|data, state| {
//!         ratatui::text::Line::from(*data)
//!     });
//!
//! let mut state = TreeViewState::new();
//! ```

pub mod helpers;
mod keybindings;
mod node_state;
mod tree_navigator;
mod tree_node;
mod tree_view_ref;
mod tree_view_state;
mod widget;

// Re-export keybindings
pub use keybindings::TreeKeyBindings;

// Re-export helpers
pub use helpers::get_visible_paths;
pub use helpers::get_visible_paths_filtered;
pub use helpers::matches_filter;

// Re-export node_state
pub use node_state::NodeState;

// Re-export tree_navigator
pub use tree_navigator::TreeNavigator;

// Re-export tree_node
pub use tree_node::TreeNode;

// Re-export widget
pub use widget::NodeRenderFn;
pub use widget::TreeView;

// Re-export tree_view_ref
pub use tree_view_ref::NodeFilterFn;
pub use tree_view_ref::NodeRenderRefFn;
pub use tree_view_ref::TreeViewRef;

// Re-export tree_view_state
pub use tree_view_state::TreeViewState;