Expand description
Shared UI protocol types used across VT Code crates.
These types form the data model shared between vtcode-core (the agent
library) and vtcode-tui (the terminal surface). Extracting them here
lets headless builds compile without duplicating every enum and struct.
The channel protocol types (InlineCommand, InlineHandle,
InlineSession) remain in the crate that owns them because the app-layer
and core-layer protocols diverge.
Structs§
- Highlighted
Segment - A syntax-highlighted text segment.
- 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
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.
- Markdown
Line - A single rendered markdown line made up of styled segments.
- Markdown
Segment - A styled segment inside a rendered markdown line.
- 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.
- Render
Markdown Options - Options for the markdown rendering pipeline.
- Secure
Prompt Config - Configuration for a secure (masked) prompt input.
- Slash
Command Item - A single slash-command entry for the suggestion palette.
- Wizard
Step - A single step in a wizard modal flow.
Enums§
- Editing
Mode - Editing mode for the agent session.
- Inline
Header Status Tone - Status-badge tone used in header status indicators.
- 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.
- Layout
Mode Override - Override for responsive layout detection.
- OpenAI
Service Tier Choice - 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.
- UiMode
- UI mode variants for quick presets.
- Wizard
Modal Mode - Wizard modal behavior variant.
Functions§
- convert_
style - Convert an
anstyle::Styleto anInlineTextStyle. - theme_
from_ color_ fields - Build an
InlineThemefrom individual theme colour fields.