Expand description
Terminal renderer for Index documents.
The renderer consumes IndexDocument only. It never parses HTML and keeps
viewport, overlays, command state, and terminal drawing local to this crate.
Structs§
- Form
Edit - Current interactive form edit state.
- Reader
Profile Suggestion - Automatic reader profile suggestion.
- Render
Options - Rendering options.
- Repair
Recipe - Local repair recipe for reproducing presentation-only fixes.
- Terminal
App - Terminal document application state.
- Terminal
Capabilities - Terminal capabilities that affect theme selection.
- Theme
- Terminal theme colors.
- TuiDocument
Result - Result returned by the host after navigation or form submission.
- Viewport
- Viewport state for the document view.
Enums§
- Animation
Mode - Terminal animation capability used for accessibility fallbacks.
- AppAction
- Result of handling a key event.
- Color
Support - Terminal color capability used to choose deterministic theme fallbacks.
- Glyph
Support - Terminal glyph capability used for icon fallback.
- Input
Mode - Current input mode.
- Reader
Profile Intent - Inferred page intent for automatic reader profile selection.
- Repair
Action - Local presentation repair action.
- Table
Mode - Table presentation mode local to the terminal renderer.
Functions§
- render_
document - Renders a document as terminal-friendly plain text.
- run_tui
- Runs the interactive TUI until the user quits.
- run_
tui_ with_ navigation - Runs the interactive TUI with a navigation handler for
:openactions. - run_
tui_ with_ navigation_ and_ profile - Runs the interactive TUI with a navigation handler and initial reader profile.
- run_
tui_ with_ navigation_ profile_ and_ forms - Runs the interactive TUI with navigation and form submission handlers.
- run_
tui_ with_ navigation_ profile_ forms_ and_ state - Runs the interactive TUI with navigation, form submission, and local session state.
- run_
tui_ with_ navigation_ profile_ forms_ and_ state_ with_ progress - Runs the interactive TUI with navigation, form submission, local session state, and progress callbacks for long-running open/submit operations.
- suggest_
reader_ profile - Returns a deterministic reader profile suggestion for a document.