Expand description
TUI module re-exports. TUI protocol types and session interface.
When the tui feature is enabled, this module re-exports the full app-layer
protocol from vtcode-ui. When the feature is disabled (headless build),
it re-exports the shared data types from vtcode-commons and provides
lightweight no-op stubs for InlineHandle, InlineSession, and
InlineEvent.
Modules§
- prelude
- Commonly used VT Code TUI API items.
Structs§
- Agent
Palette Item - Agent
Palette Transient Request - Archived
Prompt Entry - A user prompt from a previous session archive, used to populate the history picker.
- Compact
Activity Metadata - Presentation metadata for a compact command activity row.
- Diff
Hunk - A diff hunk representing a contiguous block of changes
- Diff
Overlay Request - Diff
Preview State - State for diff preview modal
- File
Palette Transient Request - Fullscreen
Interaction Settings - Standalone fullscreen interaction settings for alternate-screen behavior.
- Inline
Handle - Inline
Header Badge - A compact pill badge rendered in the header.
- Inline
Header Context - Session metadata displayed in the inline header.
- Inline
Header Highlight - A title + content highlight block in the header.
- Inline
Header Status Badge - A labelled status badge for the header bar.
- Inline
Link Range - Byte-range inside a line that is a clickable link.
- Inline
List Item - A selectable item inside a list overlay.
- Inline
List Search Config - Search configuration for a list overlay.
- Inline
Segment - A styled text segment with shared style.
- Inline
Session - Inline
Status - A short-lived status message shown inside a list modal (footer strip).
- Inline
Text Style - Inline text styling with foreground/background color and text effects.
- Inline
Theme - Resolved theme colors for inline rendering.
- Keyboard
Protocol Settings - Standalone keyboard protocol settings for terminal key event enhancements.
- List
Overlay Request - Local
Agent Entry - Local
Agents Transient Request - Modal
Overlay Request - Plan
Content - Structured plan content for display in the Implementation Blueprint panel.
- Plan
Phase - A phase in an implementation plan (groups related steps).
- Plan
Step - A step in an implementation plan.
- Progress
Guard - Scoped owner; transferring a turn preserves its monotonic start time.
- Secure
Prompt Config - Configuration for a secure (masked) prompt input.
- Session
Appearance Config - UI appearance configuration
- Session
Options - Standalone session launch options for reusable integrations.
- Slash
Command Item - A single slash-command entry for the suggestion palette.
- Submitted
Input - Task
Panel Metadata - Task
Panel Transient Request - Transient
Hotkey - Wizard
Overlay Request - Wizard
Step - A single step in a wizard modal flow.
Enums§
- Content
Part - Structured input content used by the TUI input/history systems.
- Diff
Preview Mode - Behavior mode for diff preview overlays.
- Exec
Session Action - Actions that the runloop performs for a raw background exec session.
- Inline
Command - Inline
Event - Inline
Header Status Tone - Status-badge tone used in header status indicators.
- Inline
Item Kind - Role of a list row, used by the renderer to pick emphasis and spacing.
- Inline
Link Target - A clickable link target inside a transcript line.
- Inline
List Selection - Selection value returned from a list or wizard overlay.
- Inline
Message Kind - Message kind tag for inline transcript lines.
- Inline
Tone - Semantic tone for list badges, values, and modal status strips.
- Layout
Mode Override - Override for responsive layout detection.
- Local
Agent Kind - OpenAI
Service Tier Choice - Overlay
Event - Overlay
Selection Change - Reasoning
Display Mode - Reasoning visibility behavior in the transcript.
- Rewind
Action - Rewind action choices for the rewind overlay.
- Session
Surface - Standalone surface preference for selecting inline vs alternate rendering.
- Thinking
Block State - Default collapse state of agent thinking/reasoning blocks in the transcript.
- Transient
Event - Transient
Hotkey Action - Transient
Hotkey Key - Transient
Request - Transient
Selection Change - Transient
Submission - Trust
Mode - Trust mode for diff preview - how to handle file edit approval
- UiMode
- UI mode variants for quick presets.
- Wizard
Modal Mode - Wizard modal behavior variant.
Functions§
- convert_
style - Convert an
anstyle::Styleto anInlineTextStyle. - spawn_
session_ with_ host - Spawn a session using defaults from a host adapter.
- spawn_
session_ with_ options - Spawn a session using standalone options and local config types.
- theme_
from_ color_ fields - Build an
InlineThemefrom individual theme colour fields.
Type Aliases§
- Focus
Change Callback - Inline
Event Callback - Preview
Callback - Tool
Output Id - Session-local key for a complete tool-output capture.