Brainwires/ratatui-interact
Brainwires/ratatui-interact has 41 GitHub stars and 4 forks. GitHot measured 0 stars in 24 hours, 0 in 7 days, and 0 in 15 days. Last checked 2026-11-21 08:25 UTC. Last push 2026-11-18.
What you can do
- Focus Management - Tab/Shift+Tab navigation with FocusManager<T>
- Mouse Click Support - Click regions with hit-testing via ClickRegion and ClickRegionRegistry
- Interactive Widgets - CheckBox, Input, Button, Select, ContextMenu, MenuBar, PopupDialog
- Display Widgets - ParagraphExt, Toast, Progress, MarqueeText, Spinner, MousePointer
Progression mesurée des étoiles
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- 0
- in 1 month
- Historique en cours
Variations nettes sur des périodes qui se chevauchent, pas des totaux quotidiens. Les mesures absentes restent vides. Les étoiles indiquent l’intérêt, pas la qualité.
À propos
Interactive widgets for ratatui: focus management, mouse clicks, and ready-made inputs, menus, dialogs, tree views, a file explorer and more
Outils de développementREADME.md
Originalratatui-interact
Interactive TUI components for ratatui with focus management and mouse support.
Ratatui doesn't include built-in focus navigation or mouse click handling. This library fills that gap with ready-to-use interactive widgets and a flexible composition system.
Features
- Focus Management - Tab/Shift+Tab navigation with
FocusManager<T> - Mouse Click Support - Click regions with hit-testing via
ClickRegionandClickRegionRegistry - Interactive Widgets - CheckBox, Input, Button, Select, ContextMenu, MenuBar, PopupDialog
- Display Widgets - ParagraphExt, Toast, Progress, MarqueeText, Spinner, MousePointer
- Navigation Widgets - ListPicker, TreeView, FileExplorer, Accordion
- Layout Widgets - TabView, SplitPane
- Viewer Widgets - ScrollableContent, LogViewer, DiffViewer, StepDisplay
- Color Theming - Centralized
Theme/ColorPalettewith dark/light presets; derive any component style withtheme.style::<T>() - Utilities - ANSI parsing, display helpers, View/Copy mode, exit strategies
- Composition Traits -
Focusable,Clickable,Containerfor building custom components
Installation
Add to your Cargo.toml:
[dependencies]
ratatui-interact = "0.5"
Or from git:
[dependencies]
ratatui-interact = { git = "https://github.com/Brainwires/ratatui-interact.git" }
Quick Start
use crossterm::event::Event;
use ratatui::{Frame, layout::Rect};
use ratatui_interact::prelude::*;
// The focusable elements of your screen
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
enum Element {
Name,
Enable,
}
struct App {
focus: FocusManager<Element>,
clicks: ClickRegionRegistry<Element>,
name: InputState,
enable: CheckBoxState,
}
impl App {
fn new() -> Self {
let mut focus = FocusManager::new();
focus.register_all([Element::Name, Element::Enable]);
Self {
focus,
clicks: ClickRegionRegistry::new(),
name: InputState::new("Hello"),
enable: CheckBoxState::new(false),
}
}
// Render with focus awareness, and remember where each element was drawn
fn render(&mut self, frame: &mut Frame, name_area: Rect, enable_area: Rect) {
self.name.focused = self.focus.is_focused(&Element::Name);
self.enable.focused = self.focus.is_focused(&Element::Enable);
self.clicks.clear();
let region = Input::new(&self.name)
.label("Name")
.render_stateful(frame, name_area);
self.clicks.register(region.area, Element::Name);
let region = CheckBox::new("Enable", &self.enable)
.render_stateful(enable_area, frame.buffer_mut());
self.clicks.register(region.area, Element::Enable);
}
// Tab / Shift+Tab move focus; a click focuses what was clicked
fn handle_event(&mut self, event: &Event) {
match event {
Event::Key(key) if is_tab(key) => self.focus.next(),
Event::Key(key) if is_backtab(key) => self.focus.prev(),
Event::Mouse(mouse) if is_left_click(mouse) => {
if let Some(&element) = self.clicks.handle_click(mouse.column, mouse.row) {
self.focus.set(element);
}
}
_ => {}
}
}
}
See examples/ for complete, runnable apps.
Cargo features
| Feature | What it enables |
|---|---|
filesystem |
Directory loading for FileExplorer |
clipboard |
Copy and paste through the system clipboard (arboard) |
markdown |
Markdown rendering in the ANSI parser (termimad) |
theme-serde |
serde support for Theme and ColorPalette |
The minimum supported Rust version is 1.88.
Components
Interactive Components
| Component | Description |
|---|---|
| CheckBox | Toggleable checkbox with multiple symbol styles (ASCII, Unicode, checkmark) |
| Input | Text input with cursor, insertion, deletion, and navigation |
| TextArea | Multi-line text input with cursor, line numbers, scrolling, and word wrap |
| Button | Multiple variants: SingleLine, Block, Toggle, Icon+Text |
| Select | Dropdown select box with popup options, keyboard/mouse navigation |
| ContextMenu | Right-click popup menu with actions, separators, shortcuts, and submenus |
| MenuBar | Traditional File/Edit/View/Help style menu bar with dropdowns, submenus, and shortcuts |
| PopupDialog | Container for modal dialogs with focus management |
| HotkeyDialog | Hotkey configuration dialog with search, categories, and trait-based customization |
Display Components
| Component | Description |
|---|---|
| AnimatedText | Animated text with color effects (pulse, wave, rainbow, gradient, sparkle) |
| ParagraphExt | Extended paragraph with word-wrapping and scrolling |
| Toast | Transient notification popup with auto-expiration and style variants |
| Progress | Progress bar with label, percentage, and step counter |
| MarqueeText | Scrolling text for long content in limited space (continuous, bounce, static modes) |
| Spinner | Animated loading indicator with 12 frame styles (dots, braille, line, etc.) |
| ToastStack | Queue of simultaneous overlay toasts with configurable placement, ordering, and per-toast dismiss policies |
| MousePointer | Visual indicator at mouse cursor position with customizable styles |
Navigation Components
| Component | Description |
|---|---|
| ListPicker | Scrollable list with selection cursor for picking items |
| TreeView | Collapsible tree view with selection and customizable rendering |
| FileExplorer | File browser with multi-select, search, and hidden file toggle |
| Accordion | Collapsible sections with single or multiple expansion modes |
| Breadcrumb | Hierarchical navigation path with ellipsis collapsing and keyboard/mouse support |
Layout Components
| Component | Description |
|---|---|
| TabView | Tab bar with content switching, supports top/bottom/left/right positions |
| SplitPane | Resizable split pane with drag-to-resize divider, horizontal/vertical orientations |
Viewer Components
| Component | Description |
|---|---|
| ScrollableContent | Scrollable text pane with focus support, keyboard/mouse navigation, and View/Copy mode for native terminal text selection |
| LogViewer | Scrollable log viewer with line numbers, search, and log-level coloring |
| DiffViewer | Diff viewer with unified and side-by-side modes, hunk navigation, search, and syntax highlighting |
| StepDisplay | Multi-step progress display with sub-steps and output areas |
Utilities
ANSI Parser
Parse ANSI escape codes to ratatui styles:
use ratatui_interact::utils::ansi::parse_ansi_to_spans;
let text = "\x1b[31mRed\x1b[0m Normal";
let spans = parse_ansi_to_spans(text);
Supports: SGR codes (bold, italic, colors), 256-color mode, RGB mode.
Display Utilities
use ratatui_interact::utils::display::{
truncate_to_width, pad_to_width, clean_for_display, format_size
};
let truncated = truncate_to_width("Hello World", 8); // "Hello..."
let padded = pad_to_width("Hi", 10); // "Hi "
let clean = clean_for_display("\x1b[31mText\x1b[0m");
let size = format_size(1536); // "1.5 KB"
View/Copy Mode & Exit Strategies
use ratatui_interact::utils::{ViewCopyMode, ViewCopyConfig, ExitStrategy};
// Enter view/copy mode for native terminal text selection
let mode = ViewCopyMode::enter(&mut stdout)?;
mode.print_lines(&content)?;
// ... wait for user input ...
mode.exit(&mut terminal)?;
// Choose exit strategy
let strategy = ExitStrategy::PrintContent(content); // or ExitStrategy::RestoreConsole
strategy.execute()?;
Examples
See examples/README.md for detailed code examples of each component.
Run the examples:
# Interactive Components
cargo run --example checkbox_demo # Checkbox with multiple styles
cargo run --example input_demo # Text input with cursor
cargo run --example textarea_demo # Multi-line text input
cargo run --example button_demo # Button variants and styles
cargo run --example select_demo # Dropdown select boxes
cargo run --example context_menu_demo # Right-click context menus
cargo run --example menu_bar_demo # File/Edit/View/Help style menu bar
cargo run --example dialog_demo # Modal dialogs
cargo run --example hotkey_dialog_demo # Hotkey configuration dialog
# Display & Viewer Components
cargo run --example animated_text_demo # Animated text with color effects
cargo run --example theme_demo # Theme system with dark/light switching
cargo run --example toast_stack_demo # Multiple simultaneous toasts with dismiss policies
cargo run --example marquee_demo # Scrolling text animation
cargo run --example mouse_pointer_demo # Mouse cursor indicator
cargo run --example spinner_demo # Animated loading indicators
cargo run --example display_demo # Progress, StepDisplay, ParagraphExt
cargo run --example diff_viewer_demo # Diff viewer with unified/side-by-side modes
cargo run --example copyable_pane_demo # ScrollableContent with View/Copy mode
# Navigation & Layout Components
cargo run --example accordion_demo # Collapsible sections
cargo run --example tab_view_demo # Tab bar with positions
cargo run --example split_pane_demo # Resizable split panes
cargo run --example breadcrumb_demo # Hierarchical path navigation
cargo run --example navigation_demo # ListPicker and TreeView
# Combined Demo (requires filesystem feature)
cargo run --example explorer_log_demo --features filesystem
Comparison with Alternatives
| Feature | ratatui-interact | rat-focus | tui-input |
|---|---|---|---|
| Focus management | ✅ Generic FocusManager<T> |
✅ FocusFlag based |
❌ |
| Mouse click regions | ✅ ClickRegion with hit-testing |
✅ Area-based | ❌ |
| Ready-to-use widgets | ✅ Many (see above) | ❌ | ✅ Input only |
| Composition traits | ✅ Focusable, Clickable, Container | ❌ | ❌ |
License
MIT