Struct DiffFileTree 

pub struct DiffFileTree {
    pub nodes: Vec<TreeNode<DiffFileEntry>>,
    pub state: TreeViewState,
    pub selected_index: usize,
    pub focused: bool,
    pub theme: AppTheme,
}

A tree widget for displaying changed files in a diff.

Renders a hierarchical view of files with their modification status, similar to gitui’s file tree in the changes panel.

This is a wrapper around TreeView that provides a specialized API for diff file trees.

Fields

nodes: Vec<TreeNode<DiffFileEntry>>

The tree nodes containing diff file entries.

state: TreeViewState

State for selection and expansion (managed by TreeView).

selected_index: usize

Currently selected visible row index.

focused: bool

Whether this widget currently has focus.

theme: AppTheme

Application theme for styling.

Implementations

impl DiffFileTree

pub fn from_paths<S: AsRef<str>>(paths: &[(S, FileStatus)]) -> Self

Creates a DiffFileTree from a list of (path, status) pairs.

Paths are parsed to build a hierarchical directory structure. Intermediate directories are created automatically.

Arguments

• paths - A slice of (path, status) pairs

Returns

A new DiffFileTree with the file hierarchy.

Example

use ratatui_toolkit::widgets::code_diff::diff_file_tree::{DiffFileTree, FileStatus};

let files = vec![
    ("src/lib.rs", FileStatus::Modified),
    ("src/utils/helper.rs", FileStatus::Added),
];

let tree = DiffFileTree::from_paths(&files);

impl DiffFileTree

pub fn new() -> Self

Creates a new empty DiffFileTree.

Returns

An empty tree with no files.

Example

use ratatui_toolkit::widgets::code_diff::diff_file_tree::DiffFileTree;

let tree = DiffFileTree::new();
assert!(tree.nodes.is_empty());

impl DiffFileTree

pub fn with_focus(self, focused: bool) -> Self

Sets the focus state and returns self for chaining.

This is a builder method that can be chained after constructors.

Arguments

• focused - Whether the tree should have focus

Example

use ratatui_toolkit::widgets::code_diff::diff_file_tree::{DiffFileTree, FileStatus};

let tree = DiffFileTree::from_paths(&[("src/lib.rs", FileStatus::Modified)])
    .with_focus(true);

impl DiffFileTree

pub fn with_theme(self, theme: &AppTheme) -> Self

Sets the application theme for styling.

This method applies the theme colors to the file tree widget, including selection colors, borders, and text colors.

Arguments

• theme - The application theme to use

Returns

Self for method chaining

Example

use ratatui_toolkit::widgets::code_diff::diff_file_tree::DiffFileTree;
use ratatui_toolkit::services::theme::AppTheme;

let theme = AppTheme::default();
let tree = DiffFileTree::new().with_theme(&theme);

pub fn apply_theme(&mut self, theme: &AppTheme)

Applies a theme to the existing widget (non-consuming).

Arguments

• theme - The application theme to apply

impl DiffFileTree

pub fn add_file(&mut self, path: &str, status: FileStatus)

Adds a file to the tree, creating intermediate directories as needed.

Arguments

• path - The file path (e.g., “src/utils/helper.rs”)
• status - The modification status

impl DiffFileTree

pub fn enter_filter_mode(&mut self)

Enters filter mode, initializing an empty filter.

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

Example

use ratatui_toolkit::widgets::code_diff::diff_file_tree::DiffFileTree;

let mut tree = DiffFileTree::new();
tree.enter_filter_mode();
assert!(tree.is_filter_mode());

pub fn is_filter_mode(&self) -> bool

Returns whether filter input mode is currently active.

When true, key presses should be delegated to handle_filter_key.

Returns

true if filter mode is active, false otherwise.

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

Returns the current filter text.

Returns

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

pub fn clear_filter(&mut self)

Clears the filter and exits filter mode.

This removes any active filter, showing all items again.

impl DiffFileTree

pub fn focus(&mut self)

Sets focus on this widget.

pub fn blur(&mut self)

Removes focus from this widget.

impl DiffFileTree

pub fn handle_filter_key(&mut self, key: KeyCode) -> 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

Returns

true if the key was handled, false otherwise.

Example

use crossterm::event::KeyCode;
use ratatui_toolkit::widgets::code_diff::diff_file_tree::DiffFileTree;

let mut tree = DiffFileTree::new();
tree.enter_filter_mode();

// Type a character
tree.handle_filter_key(KeyCode::Char('r'));

// Exit filter mode
tree.handle_filter_key(KeyCode::Esc);

impl DiffFileTree

pub fn select_next(&mut self)

Selects the next visible item in the tree.

Respects the current filter (if any).

pub fn select_prev(&mut self)

Selects the previous visible item in the tree.

Respects the current filter (if any).

pub fn toggle_expand(&mut self)

Toggles the expansion state of the currently selected node.

Only has an effect if the selected node is a directory.

pub fn expand_selected(&mut self)

Expands the currently selected directory.

Only has an effect if the selected node is a directory.

pub fn collapse_selected(&mut self) -> bool

Collapses the currently selected directory if it’s expanded.

Returns

true if a directory was collapsed, false otherwise (not expanded or not a directory).

pub fn go_to_parent(&mut self)

Moves selection to the parent directory of the currently selected node.

If the selected node is already at the root level, this does nothing.

pub fn goto_top(&mut self)

Goes to the first visible item in the tree.

Respects the current filter (if any).

pub fn goto_bottom(&mut self)

Goes to the last visible item in the tree.

Respects the current filter (if any).

pub fn selected_is_dir(&self) -> Option<bool>

Returns whether the selected item is a directory.

Returns

Some(true) if selected item is a directory, Some(false) if it’s a file, None if no item is selected.

pub fn visible_count(&self) -> usize

Returns the total number of visible items.

Respects the current filter (if any).

pub fn set_selected_index(&mut self, index: usize)

Sets the selection by visible index.

Respects the current filter (if any).

Arguments

• index - The 0-based index in the visible items list

impl DiffFileTree

pub fn selected_path(&self) -> Option<String>

Returns the full path of the currently selected item.

Returns

Some(path) if an item is selected, None if the tree is empty.

Trait Implementations

impl Clone for DiffFileTree

fn clone(&self) -> DiffFileTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffFileTree

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

Formats the value using the given formatter.

impl Default for DiffFileTree

fn default() -> Self

Returns the “default value” for a type.

impl Widget for &DiffFileTree

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

Renders the diff file tree widget from a reference.

Note: This creates a clone of the state for rendering. When filter mode is active, shows a filter input at the bottom.

impl Widget for DiffFileTree

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

Renders the diff file tree widget to the given buffer.

Uses TreeViewRef internally to render the tree with custom styling. When filter mode is active, shows a filter input at the bottom.