Struct FileSystemTree 

pub struct FileSystemTree<'a> {
    pub root_path: PathBuf,
    pub nodes: Vec<TreeNode<FileSystemEntry>>,
    /* private fields */
}

Available on crate feature file-tree only.

File system tree browser widget

Fields

root_path: PathBuf

Root directory to browse

nodes: Vec<TreeNode<FileSystemEntry>>

Tree nodes built from file system

Implementations

impl<'a> FileSystemTree<'a>

pub fn new(root_path: PathBuf) -> Result<Self>

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

impl<'a> FileSystemTree<'a>

pub fn with_config( root_path: PathBuf, config: FileSystemTreeConfig, ) -> Result<Self>

impl<'a> FileSystemTree<'a>

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

impl<'a> FileSystemTree<'a>

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

impl<'a> FileSystemTree<'a>

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

impl<'a> FileSystemTree<'a>

pub fn expand_directory(&mut self, path: &[usize]) -> Result<()>

impl<'a> FileSystemTree<'a>

pub fn enter_filter_mode(&self, state: &mut TreeViewState)

Enters filter mode, initializing an empty filter.

When in filter mode, key presses are handled by handle_filter_key instead of normal navigation.

Arguments

• state - The tree view state to modify

Example

use ratatui_toolkit::file_system_tree::FileSystemTree;
use ratatui_toolkit::tree_view::TreeViewState;

let tree = FileSystemTree::new(".");
let mut state = TreeViewState::new();
tree.enter_filter_mode(&mut state);
assert!(tree.is_filter_mode(&state));

pub fn is_filter_mode(&self, state: &TreeViewState) -> bool

Returns whether filter input mode is currently active.

When true, key presses should be delegated to handle_filter_key.

Arguments

• state - The tree view state to check

Returns

true if filter mode is active, false otherwise.

pub fn filter_text<'s>(&self, state: &'s TreeViewState) -> Option<&'s str>

Returns the current filter text.

Arguments

• state - The tree view state to check

Returns

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

pub fn clear_filter(&self, state: &mut TreeViewState)

Clears the filter and exits filter mode.

This removes any active filter, showing all items again.

Arguments

• state - The tree view state to modify

impl<'a> FileSystemTree<'a>

pub fn get_entry_at_path(&self, path: &[usize]) -> Option<&FileSystemEntry>

impl<'a> FileSystemTree<'a>

pub fn get_selected_entry( &self, state: &TreeViewState, ) -> Option<&FileSystemEntry>

impl<'a> FileSystemTree<'a>

pub fn get_visible_paths(&self, state: &TreeViewState) -> Vec<Vec<usize>>

impl<'a> FileSystemTree<'a>

pub fn handle_filter_key(&self, key: KeyCode, state: &mut TreeViewState) -> bool

Handles a key press while in filter mode.

Delegates to TreeNavigator::handle_filter_key for consistent filter handling across all tree components.

Key Bindings

• Esc - Clear filter and exit filter mode
• Enter - Exit filter mode (keep filter active)
• Backspace - Delete last character from filter
• Any character - Append to filter

Arguments

• key - The key code that was pressed
• state - The tree view state to modify

Returns

true if the key was handled, false otherwise.

Example

use crossterm::event::KeyCode;
use ratatui_toolkit::file_system_tree::FileSystemTree;
use ratatui_toolkit::tree_view::TreeViewState;

let tree = FileSystemTree::new(".");
let mut state = TreeViewState::new();
tree.enter_filter_mode(&mut state);

// Type a character
tree.handle_filter_key(KeyCode::Char('r'), &mut state);

// Exit filter mode
tree.handle_filter_key(KeyCode::Esc, &mut state);

impl<'a> FileSystemTree<'a>

pub fn select_next(&mut self, state: &mut TreeViewState)

impl<'a> FileSystemTree<'a>

pub fn select_previous(&mut self, state: &mut TreeViewState)

impl<'a> FileSystemTree<'a>

pub fn toggle_selected(&mut self, state: &mut TreeViewState) -> Result<()>

Trait Implementations

impl<'a> Clone for FileSystemTree<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> StatefulWidget for FileSystemTree<'a>

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.