Expand description
Optional feature-gated extensions for FrankenTUI.
Each module is behind a Cargo feature flag and can be enabled independently. These modules provide higher-level functionality built on top of the core ftui crates (render, style, text, widgets).
§Role in FrankenTUI
ftui-extras collects optional, higher-level utilities that are useful
across apps but not required by the core runtime or render kernel. It is
feature-gated to keep the base dependency graph lean.
§How it fits in the system
Extras build on ftui-render, ftui-style, ftui-text, and ftui-widgets.
You can enable only the pieces you need without pulling in everything else.
§Available Features
| Feature | Module | Description |
|---|---|---|
canvas | [canvas] | Pixel-level drawing primitives |
charts | [charts] | Chart widgets (depends on canvas) |
clipboard | [clipboard] | OSC 52 clipboard integration |
diagram | [diagram] | ASCII diagram detection and correction |
console | [console] | ANSI-aware console text processing |
export | [export] | Buffer export to HTML/SVG/text |
filesize | [filesize] | Human-readable file size formatting |
filepicker | [filepicker] | File picker state utilities |
forms | [forms] | Form layout and input widgets |
validation | [validation] | Form validation framework with composable validators |
image | [image] | Terminal image protocols (iTerm2/Kitty) |
live | [live] | Live-updating display (depends on console) |
logging | [logging] | Tracing subscriber for TUI logging |
markdown | [markdown] | Markdown to styled text rendering |
pty-capture | [pty_capture] | PTY session capture |
stopwatch | [stopwatch] | Stopwatch timing utility |
syntax | [syntax] | Syntax highlighting spans |
timer | [timer] | Countdown timer utility |
traceback | [traceback] | Error/stacktrace display |
theme | [theme] | Color themes + palette tokens |
terminal | [terminal] | ANSI escape sequence parser for terminal emulation |
text-effects | [text_effects] | Animated text effects (gradients, fades, ASCII art) |
visual-fx | [visual_fx] | Feature-gated visual FX primitives (backdrops, CPU/GPU adapters) |
fx-gpu | visual_fx::gpu | Optional GPU acceleration for metaballs (silent CPU fallback) |
help | [help] | Contextual help system with tooltips |