ratkit
Original:🇺🇸 English
Translated
Comprehensive guide for the ratkit Rust TUI component library built on ratatui 0.29, including feature flags, APIs, and implementation patterns. Use when building, debugging, or extending ratkit applications and examples.
2installs
Added on
NPX Install
npx skill4agent add alpha-innovation-labs/ratkit ratkitTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →ratkit
Comprehensive Rust TUI component library built on ratatui 0.29, providing 21 feature-gated modules (primitives, widgets, services) for building rich terminal applications.
This file provides a complete reference for working with the ratkit codebase. The repository is organized as a single crate at the root level with feature-based modularity. Use this guide to understand component relationships, find APIs, and follow established patterns when implementing new features.
Agent Operating Rules
- Single crate at root: All code is in with 21 feature flags (e.g.,
src/,button,pane)markdown-preview - Enable features explicitly: No default features; add required features to Cargo.toml (e.g., )
features = ["button", "dialog"] - Cross-feature dependencies: Some features auto-enable others (e.g., enables
tree-view,widget-eventenablesrepo-watcherandfile-watcher)git-watcher - Use for all operations: Build (
just), test (just build), check (just test), demos (just check)just demo - Run examples with flag: Examples require their specific features (e.g.,
--features)--features markdown-preview - Use module-path imports first: Prefer explicit module paths (e.g., ,
use ratkit::primitives::button::Button) because crate-root re-exports are not guaranteed for every typeuse ratkit::widgets::markdown_preview::MarkdownWidget - StatefulWidget pattern: Complex widgets require separate state structs persisted in app state
- Event loop polling: Services require regular calls in the event loop
check_for_changes() - Mouse capture required: Enable crossterm mouse capture for interactive widgets
- Persist widget state: Never create widget state in render loops - store in app struct
- Validate before commits: Run (format + lint + test) before committing
just check - Verify feature flags: Compilation errors often indicate missing feature flags in Cargo.toml
Environment and Version Constraints
- Rust 1.70+ required (workspace.rust-version in Cargo.toml)
- ratatui 0.29 as the underlying rendering library
- crossterm 0.28 for terminal input/events
- tokio for async runtime
- Single crate at root with 21 feature flags (no workspace members)
- 23 examples in (moved from
examples/)crates/ratkit/examples/ - Optional external deps: notify (file watching), reqwest (ai-chat), pulldown-cmark/syntect (markdown), similar (code-diff)
Quick Task Playbooks
Run an example
- Where to edit: N/A
- Related files:
examples/ - Validation:
cargo run --example button_button_demo --features button
Extract smooth-redraw patterns from markdown preview demo
- Where to edit: target app event loop () and draw path (
on_event)on_draw - Related files:
examples/markdown_preview_markdown_preview_demo.rs - Goal: Port the demo's event-pressure controls and redraw strategy into other TUIs
- Validation: Under rapid mouse movement and wheel input, app remains responsive without event backlog
Run with just
- Where to edit: N/A
- Related files:
justfile - Validation: (interactive picker) or
just demo,just demo-md,just demo-md-small, etc.just demo-term
Build with specific features
- Where to edit: (root level)
Cargo.toml - Related files: Feature definitions
- Validation:
cargo build --features "button,pane,dialog"
Build all features
- Where to edit: N/A
- Related files: All source files
- Validation:
cargo build --all-features
Run full verification
- Where to edit: N/A
- Related files: All source files
- Validation: (runs fmt-check, lint, test)
just check
Getting Started
toml
# Cargo.toml - enable specific features
[dependencies]
ratkit = { version = "0.2.12", features = ["button", "dialog", "pane"] }rust
use ratkit::prelude::*;
use ratatui::Frame;
struct MyApp;
impl CoordinatorApp for MyApp {
fn on_event(&mut self, event: CoordinatorEvent) -> LayoutResult<CoordinatorAction> {
match event {
CoordinatorEvent::Keyboard(keyboard) => {
if keyboard.is_escape() {
return Ok(CoordinatorAction::Quit);
}
}
_ => {}
}
Ok(CoordinatorAction::Continue)
}
fn on_draw(&mut self, frame: &mut Frame) {
// Render your UI here
}
}
fn main() -> std::io::Result<()> {
let app = MyApp;
run(app, RunnerConfig::default())
}Workspace Overview
The ratkit workspace contains a single crate with 21 feature-gated modules organized into:
- Primitives (11 modules): Core UI building blocks in
src/primitives/- button, pane, dialog, toast, statusline, scroll, menu_bar, resizable_grid, tree_view, widget_event, termtui
- Widgets (6 modules): Higher-level composite widgets in
src/widgets/- markdown_preview, code_diff, ai_chat, hotkey_footer, file_system_tree, theme_picker
- Services (4 modules): Background monitoring services in
src/services/- file_watcher, git_watcher, repo_watcher, hotkey_service
- Core Runtime (1 module): Application lifecycle in
src/core/
All modules follow feature-gated compilation. Enable only what you need.
Core Runtime
The core runtime provides the application lifecycle, event routing, and element management for terminal UI applications.
Key Components
- CoordinatorApp trait: Applications implement this to receive events and render
- run() / run_with_diagnostics(): Entry points to start the event loop
- Element trait: Implement for custom widgets that integrate with the coordinator
- RunnerConfig: Configuration for tick rate, layout debounce, mouse capture
Architecture
- Three-region layout: Top, Center, Bottom
- Focus management with stack and traversal
- Mouse routing with z-order hit testing
- Element registry with weak references
UI Primitives
Core UI building blocks for TUI applications, located in .
src/primitives/Feature Flags
Each primitive has an individual feature flag:
- ,
button,pane,dialog,toast,statuslinescroll - (enables
menu-bar)widget-event resizable-grid- (enables
tree-view)widget-event widget-eventtermtui
Common Patterns
- Builder pattern with and
new()methodswith_* - StatefulWidget pattern for complex state
- Event emission via
WidgetEvent - Mouse/keyboard interaction support
MenuBar Layout Contract (updated)
- now uses the full available container width for the border:
MenuBar::render_with_offset(frame, area, left_offset)area.width - left_offset - The menu bar border should stretch to the right edge of the provided container, while menu items remain left-aligned within the bar
- If available width is zero after offset, rendering exits early and clears
self.area - This behavior was validated with at fixed 120-column terminal width
examples/menu-bar_menu_bar_demo.rs
Complex Widgets
Higher-level composite widgets in .
src/widgets/Feature Flags
- - Most complex (syntax highlighting, TOC, themes, selection)
markdown-preview - - VS Code-style diff viewer
code-diff - - AI chat interface (requires reqwest, serde)
ai-chat - - Keyboard shortcut footer
hotkey-footer - - File browser with devicons
file-system-tree - - Theme selector with 25+ themes
theme-picker
External Dependencies
| Widget | Dependencies |
|---|---|
| ai-chat | reqwest, serde, serde_json |
| markdown-preview | pulldown-cmark, syntect, syntect-tui, notify, arboard, dirs |
| code-diff | similar |
| file-system-tree | devicons |
FileSystemTree visual parity notes (Yazi-style)
When adjusting visuals, keep these conventions to match Yazi-like behavior:
file-system-tree- Prefer (hex) for file icon colors instead of hardcoded extension maps.
devicons::icon_for_file(...).color - Parse devicons hex colors into before rendering.
ratatui::style::Color::Rgb - Selected row background should use item color (directory rows use dir color; file rows use file color) with black foreground text.
- Keep row content alignment stable between selected and non-selected states (avoid 1-column shifts when drawing decorations).
- Directory selection should use a filled highlight; file selection may use rounded edge glyphs if desired.
Services
Background monitoring services in .
src/services/Feature Flags
- - Watch files/directories for changes
file-watcher - - Monitor git repository state
git-watcher - - Combined file + git watching (enables file-watcher and git-watcher)
repo-watcher - - Global hotkey registration and management
hotkey-service
Common Dependencies
All watcher services use the crate for filesystem events.
notifyUsage Cards
CoordinatorApp
- Use when: Building any ratkit TUI application
- Enable/Install: Core runtime, no feature flag needed
- Import/Invoke:
use ratkit::prelude::*; - Minimal flow:
- Define struct implementing
CoordinatorApp - Implement to handle events
on_event() - Implement to render UI
on_draw() - Call
run(app, RunnerConfig::default())
- Define struct implementing
- Key APIs: ,
on_event(),on_draw()on_layout_changed() - Pitfalls: Runner takes ownership; wrap shared state in
Arc<RwLock<>> - Source: ,
src/coordinator.rssrc/runner_helper.rs
run()
- Use when: Starting the main application event loop
- Enable/Install: Core runtime, no feature flag
- Import/Invoke:
use ratkit::{run, run_with_diagnostics}; - Minimal flow:
- Create app implementing
CoordinatorApp - Create or custom
RunnerConfig::default() - Call or
run(app, config)for debug overlayrun_with_diagnostics(app, config)
- Create app implementing
- Key APIs: ,
run(),run_with_diagnostics()RunnerConfig - Pitfalls: Blocks until exit; handles terminal init/cleanup
- Source:
src/runner_helper.rs
Element
- Use when: Creating custom widgets that integrate with coordinator
- Enable/Install: Core runtime
- Import/Invoke:
use ratkit::Element; - Minimal flow:
- Implement trait for your widget
Element - Define ,
id(),on_render(),on_keyboard()on_mouse() - Register with and region
ElementMetadata
- Implement
- Key APIs: ,
id(),on_render(),on_keyboard(),on_mouse(),on_focus_gain(),on_focus_loss()on_tick() - Pitfalls: Registry stores weak refs - keep strong refs in app state; return when handling events
true - Source:
src/registry.rs
Button
- Use when: Clickable button with hover states
- Enable/Install:
features = ["button"] - Import/Invoke:
use ratkit::Button; - Minimal flow:
- Create
Button::new("Label") - Call on mouse move
update_hover(x, y) - Call on click
is_clicked(x, y) - Render with
render_with_title()
- Create
- Key APIs: ,
new(),normal_style(),hover_style(),update_hover()is_clicked() - Pitfalls: State must persist in app struct
- Source:
src/primitives/button/widget.rs
Pane
- Use when: Styled panel container with title/icon/padding
- Enable/Install:
features = ["pane"] - Import/Invoke:
use ratkit::Pane; - Minimal flow:
- Create
Pane::new("Title") - Chain builder methods: ,
with_icon(),with_padding()border_style() - Render as widget
- Create
- Key APIs: ,
new(),with_icon(),with_padding(),with_uniform_padding()border_style() - Pitfalls: Padding reduces inner content area
- Source:
src/primitives/pane/mod.rs
Dialog
- Use when: Modal dialogs for confirmation/information
- Enable/Install:
features = ["dialog"] - Import/Invoke:
use ratkit::primitives::dialog::{Dialog, DialogWidget, DialogAction, DialogActionsLayout, DialogWrap, DialogShadow, DialogModalMode}; - Minimal flow:
- Create or
Dialog::new(title, message)Dialog::confirm(...) - Configure layout and visuals with ,
.actions_layout(...),.message_alignment(...),.content_padding(...),.wrap_mode(...),.shadow(...).overlay(...) - Configure actions/keys with ,
.buttons(...),.default_selection(...),.next_keys(...),.previous_keys(...),.confirm_keys(...).cancel_keys(...) - In event loop, route keys to and react to
dialog.handle_key_event(...)DialogAction - Render with
DialogWidget::new(&mut dialog)
- Create
- Key APIs: ,
actions_layout(),actions_alignment(),message_alignment(),content_padding(),wrap_mode(),hide_footer(),footer(),footer_style(),shadow(),overlay(),modal_mode(),body_renderer(),handle_key_event(),handle_mouse_confirm()blocks_background_events() - Pitfalls: If you want to control inner body UI (for example a list) instead of dialog actions, remove
Tabfrom dialog keymap and handle it in your app event loop; if you want no action row, setTab.buttons(vec![]) - Source:
src/primitives/dialog/
Dialog interaction patterns
- Vertical actions: for stacked action menus
.actions_layout(DialogActionsLayout::Vertical) - Horizontal actions: for classic Yes/No rows
.actions_layout(DialogActionsLayout::Horizontal) - No actions shown: hides the actions row so dialog body content can be primary
.buttons(vec![]) - Custom body widget: implement and pass
DialogBodyRendererto render a selectable list/menu inside dialog chrome.body_renderer(Box::new(...)) - Blocking modal: plus
.modal_mode(DialogModalMode::Blocking)to prevent background input handlingblocks_background_events() - Tab delegation: use /
.next_keys(...)to exclude.previous_keys(...)and routeTabto body-level focus/selection logicTab
Toast
- Use when: Auto-dismissing notifications
- Enable/Install:
features = ["toast"] - Import/Invoke:
use ratkit::{ToastManager, ToastLevel}; - Minimal flow:
- Create in app state
ToastManager::new() - Add toasts via ,
.success(),.error(),.info().warning() - Call before render
cleanup() - Render with
render_toasts()
- Create
- Key APIs: ,
ToastManager::new(),.add(),.success(),.error().cleanup() - Pitfalls: Must call to remove expired; doesn't auto-expire
cleanup() - Source:
src/primitives/toast/
MenuBar
- Use when: Top-level horizontal navigation with mouse and keyboard selection
- Enable/Install: (auto-enables
features = ["menu-bar"])widget-event - Import/Invoke:
use ratkit::primitives::menu_bar::{MenuBar, MenuItem}; - Minimal flow:
- Create
MenuBar::new(vec![MenuItem::new("File", 0), ...]) - Optionally set initial selection with
.with_selected(index) - On mouse move: call ; on click: call
update_hover(x, y)orhandle_click(x, y)handle_mouse(x, y) - Render with or
render()render_with_offset()
- Create
- Key APIs: ,
new(),with_selected(),update_hover(),handle_click(),handle_mouse(),selected()render_with_offset() - Pitfalls: Border fills full container width; do not assume border auto-sizes to label content
- Source: ,
src/primitives/menu_bar/menu_bar.rsexamples/menu-bar_menu_bar_demo.rs
TreeView
- Use when: Hierarchical data with expand/collapse/selection
- Enable/Install: (auto-enables widget-event)
features = ["tree-view"] - Import/Invoke:
use ratkit::{TreeNode, TreeView, TreeViewState, TreeNavigator}; - Minimal flow:
- Build hierarchy
TreeNode - Create with render_fn
TreeView::new(nodes) - Create for selection/expansion
TreeViewState::new() - Use for keyboard handling
TreeNavigator
- Build
- Key APIs: ,
TreeNode::new(),TreeView::new(),TreeViewState::new()TreeNavigator::new() - Pitfalls: TreeViewState must persist; TreeNavigator handles all keyboard nav
- Source:
src/primitives/tree_view/
MarkdownWidget
- Use when: Rendering markdown with syntax highlighting, TOC, themes
- Enable/Install: (complex dependencies)
features = ["markdown-preview"] - Import/Invoke:
use ratkit::widgets::markdown_preview::{MarkdownWidget, ScrollState, SourceState, ...}; - Minimal flow:
- Create state structs (ScrollState, SourceState, etc.) in app state
- Create
MarkdownWidget::new(content, scroll, source, ...) - Handle keyboard with
handle_key() - Render with ratatui
- Key APIs: ,
new(),handle_key(),handle_mouse(),.show_toc(),.toggle_toc(),.with_frontmatter_collapsed(),set_frontmatter_collapsed().show_scrollbar() - Pitfalls: Requires mouse capture enabled; state must persist across renders; frontmatter collapse is section-based (section id ); large markdown with many fenced code blocks can increase first-render time if syntax highlighter initialization is repeated (parser now reuses one
0per parse call)SyntaxHighlighter - Source:
src/widgets/markdown_preview/widgets/markdown_widget/
Markdown demo variants
- Use when: Choosing markdown content size for preview behavior checks
- Run: (opencode SDK skill markdown) and
just demo-md(ratkit skill markdown)just demo-md-small - Expected behavior: Both variants render with TOC, statusline, hover interactions, and copy support
- Startup profiling: Run (with
target/debug/examples/markdown_preview_markdown_preview_demo --startup-probe) to printRATKIT_MD_DEMO_FILE=...for repeatable load-time comparisonsMARKDOWN_DEMO_READY_MS=<ms> - Source: ,
examples/markdown_preview_markdown_preview_demo.rsjustfiles/utilities/demo-md.just
FileSystemTree
- Use when: Browsing local files/directories with icons and keyboard navigation
- Enable/Install:
features = ["file-system-tree"] - Import/Invoke:
use ratkit::widgets::file_system_tree::{FileSystemTree, FileSystemTreeState, FileSystemTreeConfig}; - Minimal flow:
- Create or
FileSystemTree::new(root_path)with_config(...) - Persist in app state
FileSystemTreeState - Route nav keys to
handle_navigation_key(...) - Route filter keys to when filter mode is active
handle_filter_key(...)
- Create
- Key APIs: ,
new(),with_config(),handle_navigation_key(),enter_filter_mode(),expand_selected()collapse_selected() - Pitfalls: Keep icon colors sourced from devicons, and preserve selection-row alignment when adding rounded highlight glyphs
- Source: ,
src/widgets/file_system_tree/widget.rs,src/widgets/file_system_tree/config.rssrc/widgets/file_system_tree/state.rs
FileWatcher
- Use when: Detecting file/directory changes
- Enable/Install: (uses notify crate)
features = ["file-watcher"] - Import/Invoke:
use ratkit::services::file_watcher::FileWatcher; - Minimal flow:
- Create or
FileWatcher::for_file()FileWatcher::for_directory() - Call
watch(path) - Poll in event loop
check_for_changes() - Get changes with
get_changed_paths()
- Create
- Key APIs: ,
for_file(),for_directory(),watch(),check_for_changes()get_changed_paths() - Pitfalls: Must poll regularly; clears queue; debounced (100ms/200ms)
get_changed_paths() - Source:
src/services/file_watcher/
HotkeyService
- Use when: Centralized hotkey management with scope filtering
- Enable/Install:
features = ["hotkey-service"] - Import/Invoke:
use ratkit::services::hotkey_service::{Hotkey, HotkeyRegistry, HotkeyScope}; - Minimal flow:
- Create
HotkeyRegistry::new() - Register hotkeys with
Hotkey::new(key, description).scope(scope) - Set active scope with
set_active_scope() - Query with in event loop
lookup(key, scope)
- Create
- Key APIs: ,
HotkeyRegistry::new(),register(),lookup()set_active_scope() - Pitfalls: Uses for scopes; must handle crossterm events separately
&'static str - Source:
src/services/hotkey_service/
API Reference
Core Runtime
| Component | Key APIs |
|---|---|
| CoordinatorApp | |
| run | |
| Element | |
| RunnerConfig | |
Primitives
| Primitive | Key APIs |
|---|---|
| Button | |
| Pane | |
| Dialog | |
| Toast | |
| TreeView | |
| Scroll | |
Services
| Service | Key APIs |
|---|---|
| FileWatcher | |
| GitWatcher | |
| RepoWatcher | |
| HotkeyRegistry | |
Common Pitfalls
Feature Flags
- No default features: Must explicitly enable every feature you use
- Cross-feature deps: enables
tree-view;widget-eventenablesrepo-watcherandfile-watchergit-watcher - Missing feature errors: "unresolved import" usually means missing feature flag
State Management
- StatefulWidget pattern: Complex widgets require persistent state in app struct
- Never create state in render: Always store widget state in app struct
- Weak references: Element registry stores weak refs - keep strong refs in app
Event Handling
- Return values: Return when consuming events,
trueto propagatefalse - Mouse capture: Must enable crossterm mouse capture for interactions
- Poll services: Must call regularly on watchers
check_for_changes()
Examples
- Feature flags required: Examples need their specific features:
--features markdown-preview - Just commands: Use for interactive picker or
just demofor specific demosjust demo-* - Port behavior, not just API calls: Reuse input coalescing and selective redraw patterns from demos, not only widget construction code
Smooth Redraw Patterns (Extracted from Markdown Preview Demo)
Use this section to transfer the demo's responsiveness patterns into other ratkit apps.
Core anti-throttling techniques
-
Coalesce high-rate mouse move events
- Pattern: On , skip handling if last processed move was too recent.
MouseEventKind::Moved - Demo value: ~24ms guard ().
last_move_processed.elapsed() < Duration::from_millis(24) - Effect: Prevents motion events from overwhelming the queue during fast pointer movement.
- Pattern: On
-
Gate redraws to meaningful state changes
- Pattern: Return by default for move events; return
CoordinatorAction::Continueonly when UI state actually changes.Redraw - Demo behavior: Move events redraw only on .
MarkdownEvent::TocHoverChanged { .. } - Effect: Avoids redraw storms and keeps frame pacing stable.
- Pattern: Return
-
Use differential handling for move vs non-move mouse events
- Pattern: Treat clicks/wheel/drag as higher-value events and redraw immediately; aggressively filter move-only noise.
- Effect: Maintains interaction fidelity while reducing unnecessary render pressure.
-
Bound periodic work with moderate tick rate
- Pattern: Configure non-aggressive ticks and use tick handler for lightweight maintenance only.
- Demo value: .
RunnerConfig { tick_rate: Duration::from_millis(250), .. } - Effect: Reduces idle churn and avoids periodic tasks competing with interactive redraws.
-
Persist heavy widget state outside draw loop
- Pattern: Store all stateful structs in app state and mutate incrementally in event handlers.
- Demo structures: ,
ScrollState,SourceState,CacheState,CollapseState,ExpandableState,GitStatsState,VimState,SelectionState.DoubleClickState - Effect: Prevents reallocation/reparse overhead on each frame and stabilizes render latency.
-
Keeprender-only
on_draw- Pattern: Avoid heavy parsing, file reads, or expensive recomputation in ; do those on state transitions.
on_draw - Effect: More predictable frame time and smoother UI under bursty input.
- Pattern: Avoid heavy parsing, file reads, or expensive recomputation in
Event-loop blueprint to reuse in other apps
- Keyboard: early-return for non-keydown; map only actionable keys to state changes, then redraw.
Continue - Mouse moved: coalesce by time window; update hover state; redraw only on meaningful diff.
- Mouse non-moved: apply action (click/wheel/selection), then redraw.
- Tick: run lightweight expirations/cleanup; redraw only when cleanup changed visible state.
- Resize: redraw.
Porting checklist (copy into new feature work)
- Add to app state and time-gate move handling.
last_move_processed: Instant - Ensure event handlers return unless visible state changed.
Continue - Separate ephemeral notifications/cleanup into tick-driven maintenance.
- Keep widget state persistent and mutate in place.
- Verify smoothness under rapid mouse movement and continuous wheel scrolling.
Optional
Additional Resources
- Examples: 23 examples in
examples/ - Just commands: Run for all available commands
just help - Build: or
just buildcargo build -p ratkit --all-features - Test:
just test
Version
- Current: 0.2.12
- Rust: 1.70+