Skip to main content

Module ui_protocol

Module ui_protocol 

Source
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§

HighlightedSegment
A syntax-highlighted text segment.
InlineHeaderBadge
A compact pill badge rendered in the header.
InlineHeaderContext
Session metadata displayed in the inline header.
InlineHeaderHighlight
A title + content highlight block in the header.
InlineHeaderStatusBadge
A labelled status badge for the header bar.
InlineLinkRange
Byte-range inside a line that is a clickable link.
InlineListItem
A selectable item inside a list overlay.
InlineListSearchConfig
Search configuration for a list overlay.
InlineSegment
A styled text segment with shared style.
InlineTextStyle
Inline text styling with foreground/background color and text effects.
InlineTheme
Resolved theme colors for inline rendering.
KeyboardProtocolSettings
Standalone keyboard protocol settings for terminal key event enhancements.
MarkdownLine
A single rendered markdown line made up of styled segments.
MarkdownSegment
A styled segment inside a rendered markdown line.
PlanContent
Structured plan content for display in the Implementation Blueprint panel.
PlanPhase
A phase in an implementation plan (groups related steps).
PlanStep
A step in an implementation plan.
RenderMarkdownOptions
Options for the markdown rendering pipeline.
SecurePromptConfig
Configuration for a secure (masked) prompt input.
SlashCommandItem
A single slash-command entry for the suggestion palette.
WizardStep
A single step in a wizard modal flow.

Enums§

EditingMode
Editing mode for the agent session.
InlineHeaderStatusTone
Status-badge tone used in header status indicators.
InlineLinkTarget
A clickable link target inside a transcript line.
InlineListSelection
Selection value returned from a list or wizard overlay.
InlineMessageKind
Message kind tag for inline transcript lines.
LayoutModeOverride
Override for responsive layout detection.
OpenAIServiceTierChoice
ReasoningDisplayMode
Reasoning visibility behavior in the transcript.
RewindAction
Rewind action choices for the rewind overlay.
SessionSurface
Standalone surface preference for selecting inline vs alternate rendering.
UiMode
UI mode variants for quick presets.
WizardModalMode
Wizard modal behavior variant.

Functions§

convert_style
Convert an anstyle::Style to an InlineTextStyle.
theme_from_color_fields
Build an InlineTheme from individual theme colour fields.