ratatui-interact 0.5.3

Interactive TUI components for ratatui with focus management and mouse support
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! UI Components
//!
//! This module provides reusable interactive UI components that extend ratatui.
//!
//! # Components
//!
//! ## Interactive Components
//! - [`CheckBox`] - Toggleable checkbox with label
//! - [`Input`] - Text input field with cursor
//! - [`TextArea`] - Multi-line text input with cursor and scrolling
//! - [`Button`] - Various button styles
//! - [`Select`] - Dropdown select box with popup options
//! - [`ContextMenu`] - Right-click popup menu with actions and submenus
//! - [`MenuBar`] - Horizontal menu bar with dropdown menus (File, Edit, View, Help style)
//! - [`PopupDialog`] - Container for popup dialogs
//!
//! ## Display Components
//! - [`AnimatedText`] - Animated text with color effects (pulse, wave, rainbow)
//! - [`ParagraphExt`] - Extended paragraph with word-wrapping and scrolling
//! - [`Toast`] - Toast notifications with auto-dismiss
//! - [`Progress`] - Progress bar with label and percentage
//! - [`MarqueeText`] - Scrolling text for long content in limited space
//! - [`Spinner`] - Animated loading/processing indicator with multiple styles
//!
//! ## Navigation Components
//! - [`ListPicker`] - Scrollable list with selection
//! - [`TreeView`] - Collapsible tree view with selection
//! - [`FileExplorer`] - File browser with multi-select
//! - [`Accordion`] - Collapsible sections with single or multiple expansion
//! - [`Breadcrumb`] - Hierarchical navigation path with ellipsis collapsing
//!
//! ## Layout Components
//! - [`TabView`] - Tab bar with switchable content panes
//! - [`SplitPane`] - Resizable split pane with drag-to-resize divider
//!
//! ## Utility Components
//! - [`MousePointer`] - Visual indicator at mouse cursor position
//!
//! ## Dialog Components
//! - [`HotkeyDialog`] - Hotkey configuration dialog with search and categories
//!
//! ## Viewer Components
//! - [`LogViewer`] - Scrollable log viewer with search
//! - [`DiffViewer`] - Diff viewer with unified and side-by-side modes
//! - [`StepDisplay`] - Multi-step progress display

pub mod accordion;
pub mod animated_text;
pub mod breadcrumb;
pub mod button;
pub mod checkbox;
pub mod container;
pub mod context_menu;
pub mod diff_viewer;
pub mod file_explorer;
pub mod hotkey_dialog;
pub mod input;
pub mod list_picker;
pub mod log_viewer;
pub mod marquee;
pub mod menu_bar;
pub mod mouse_pointer;
pub mod paragraph_ext;
pub mod progress;
pub mod scrollable_content;
pub mod select;
pub mod spinner;
pub mod split_pane;
pub mod step_display;
pub mod tab_view;
pub mod textarea;
pub mod toast;
pub mod toast_stack;
pub mod tree_view;

pub use accordion::{
    Accordion, AccordionMode, AccordionState, AccordionStyle, calculate_height as accordion_height,
    handle_accordion_key, handle_accordion_mouse,
};
pub use animated_text::{
    AnimatedText, AnimatedTextEffect, AnimatedTextState, AnimatedTextStyle, WaveDirection,
};
pub use breadcrumb::{
    Breadcrumb, BreadcrumbAction, BreadcrumbItem, BreadcrumbState, BreadcrumbStyle,
    get_hovered_index as breadcrumb_hovered_index, handle_breadcrumb_key, handle_breadcrumb_mouse,
};
pub use button::{Button, ButtonAction, ButtonState, ButtonStyle, ButtonVariant};
pub use checkbox::{CheckBox, CheckBoxAction, CheckBoxState, CheckBoxStyle};
pub use container::{DialogConfig, DialogFocusTarget, DialogState, PopupDialog};
pub use context_menu::{
    ContextMenu, ContextMenuAction, ContextMenuItem, ContextMenuState, ContextMenuStyle,
    calculate_menu_height, handle_context_menu_key, handle_context_menu_mouse,
    is_context_menu_trigger,
};
pub use diff_viewer::{
    DiffData, DiffHunk, DiffLine, DiffLineType, DiffViewMode, DiffViewer, DiffViewerAction,
    DiffViewerState, DiffViewerStyle, handle_diff_viewer_key, handle_diff_viewer_mouse,
};
pub use file_explorer::{EntryType, FileEntry, FileExplorer, FileExplorerState, FileExplorerStyle};
pub use hotkey_dialog::{
    CategoryClickRegion, HotkeyCategory, HotkeyClickRegion, HotkeyDialog, HotkeyDialogAction,
    HotkeyDialogState, HotkeyDialogStyle, HotkeyEntryData, HotkeyFocus, HotkeyProvider,
    handle_hotkey_dialog_key, handle_hotkey_dialog_mouse, is_close_key as hotkey_is_close_key,
    is_navigation_key as hotkey_is_navigation_key, render_hotkey_dialog,
};
pub use input::{Input, InputAction, InputState, InputStyle};
pub use list_picker::{ListPicker, ListPickerState, ListPickerStyle, key_hints_footer};
pub use log_viewer::{LogViewer, LogViewerState, LogViewerStyle, SearchState};
pub use marquee::{
    MarqueeMode, MarqueeState, MarqueeStyle, MarqueeText, ScrollDir, bounce_marquee,
    continuous_marquee,
};
pub use menu_bar::{
    Menu, MenuBar, MenuBarAction, MenuBarClickTarget, MenuBarItem, MenuBarState, MenuBarStyle,
    calculate_dropdown_height as menu_bar_dropdown_height, calculate_menu_bar_height,
    handle_menu_bar_key, handle_menu_bar_mouse,
};
pub use mouse_pointer::{MousePointer, MousePointerState, MousePointerStyle};
pub use paragraph_ext::ParagraphExt;
pub use progress::{Progress, ProgressStyle};
pub use scrollable_content::{
    ScrollableContent, ScrollableContentAction, ScrollableContentState, ScrollableContentStyle,
    handle_scrollable_content_key, handle_scrollable_content_mouse,
};
pub use select::{
    Select, SelectAction, SelectState, SelectStyle, calculate_dropdown_height, handle_select_key,
    handle_select_mouse,
};
pub use spinner::{LabelPosition, Spinner, SpinnerFrames, SpinnerState, SpinnerStyle};
pub use split_pane::{
    Orientation, SplitPane, SplitPaneAction, SplitPaneState, SplitPaneStyle, handle_split_pane_key,
    handle_split_pane_mouse,
};
pub use step_display::{
    Step, StepDisplay, StepDisplayState, StepDisplayStyle, StepStatus, SubStep,
    calculate_height as step_display_height,
};
pub use tab_view::{
    Tab, TabPosition, TabView, TabViewAction, TabViewState, TabViewStyle, handle_tab_view_key,
    handle_tab_view_mouse,
};
pub use textarea::{
    CursorMode, ScrollMode, TabConfig, TextArea, TextAreaAction, TextAreaRender, TextAreaState,
    TextAreaStyle, WrapMode,
};
pub use toast::{Toast, ToastState, ToastStyle};
pub use toast_stack::{
    ToastDismissPolicy, ToastId, ToastItem, ToastOrder, ToastPlacement, ToastStack,
    ToastStackLayout, ToastStackState,
};
pub use tree_view::{FlatNode, TreeNode, TreeStyle, TreeView, TreeViewState, get_selected_id};