Skip to main content

UiConfig

Struct UiConfig 

Source
pub struct UiConfig {
Show 36 fields pub tool_output_mode: ToolOutputMode, pub tool_display_mode: ToolDisplayMode, pub keybindings: HashMap<String, Vec<String>>, pub tool_output_max_lines: usize, pub tool_output_spool_bytes: usize, pub tool_output_spool_dir: Option<String>, pub allow_tool_ansi: bool, pub inline_viewport_rows: u16, pub reasoning_display_mode: ReasoningDisplayMode, pub reasoning_visible_default: bool, pub thinking_display: ThinkingBlockState, pub vim_mode: bool, pub status_line: StatusLineConfig, pub terminal_title: TerminalTitleConfig, pub keyboard_protocol: KeyboardProtocolConfig, pub layout_mode: LayoutModeOverride, pub display_mode: UiDisplayMode, pub show_sidebar: bool, pub dim_completed_todos: bool, pub show_task_panel: bool, pub message_block_spacing: bool, pub show_turn_timer: bool, pub show_diagnostics_in_transcript: bool, pub minimum_contrast: f32, pub bold_is_bright: bool, pub safe_colors_only: bool, pub color_scheme_mode: ColorSchemeMode, pub program_status: UiProgramStatusConfig, pub notifications: UiNotificationsConfig, pub fullscreen: UiFullscreenConfig, pub screen_reader_mode: bool, pub reduce_motion_mode: bool, pub reduce_motion_keep_progress_animation: bool, pub hide_header: bool, pub diff_preview_mode: DiffPreviewMode, pub transcript_review: UiTranscriptReviewConfig,
}

Fields§

§tool_output_mode: ToolOutputMode

Tool output display mode (“compact” or “full”)

§tool_display_mode: ToolDisplayMode

Tool transition summary display mode Options: “expanded” (expanded summary layout) or “compact” (one compact summary per tool call)

§keybindings: HashMap<String, Vec<String>>

Session action bindings. Each action maps to one or more key specs; an empty list explicitly unbinds the built-in action.

§tool_output_max_lines: usize

Maximum number of lines to display in tool output (prevents transcript flooding)

§tool_output_spool_bytes: usize

Maximum bytes of output to display before auto-spooling to disk

§tool_output_spool_dir: Option<String>

Optional custom directory for spooled tool output logs

§allow_tool_ansi: bool

Allow ANSI escape sequences in tool output (enables colors but may cause layout issues)

§inline_viewport_rows: u16

Number of rows to allocate for inline UI viewport

§reasoning_display_mode: ReasoningDisplayMode

Reasoning display mode for chat UI (“always”, “toggle”, or “hidden”)

§reasoning_visible_default: bool

Default visibility for reasoning when display mode is “toggle”

§thinking_display: ThinkingBlockState

Default collapse state of agent thinking/reasoning blocks (“collapsed” or “extended”)

§vim_mode: bool

Enable Vim-style prompt editing in the interactive terminal UI.

§status_line: StatusLineConfig

Status line configuration settings

§terminal_title: TerminalTitleConfig

Terminal title configuration settings

§keyboard_protocol: KeyboardProtocolConfig

Keyboard protocol enhancements for modern terminals (e.g. Kitty protocol)

§layout_mode: LayoutModeOverride

Override the responsive layout mode

§display_mode: UiDisplayMode

UI display mode preset (full, minimal, focused)

§show_sidebar: bool

Show the right sidebar (queue, context, tools)

§dim_completed_todos: bool

Dim completed todo items (- [x]) in agent output

§show_task_panel: bool

Automatically show the plan-mode TODO task tracking panel when a plan is approved or the task tracker is updated. When disabled, the panel can still be toggled with the toggle_task_panel keybinding.

§message_block_spacing: bool

Add spacing between message blocks

§show_turn_timer: bool

Show per-turn elapsed timer line after completed turns

§show_diagnostics_in_transcript: bool

Show warning/error/fatal diagnostic lines in the TUI transcript and log panel. Also controls whether ERROR-level tracing logs appear in the TUI session log. Errors are always captured in the session archive JSON regardless of this setting.

§minimum_contrast: f32

Minimum contrast ratio for text against background (WCAG 2.1 standard)

  • 4.5: WCAG AA (default, suitable for most users)
  • 7.0: WCAG AAA (enhanced, for low-vision users)
  • 3.0: Large text minimum
  • 1.0: Disable contrast enforcement
§bold_is_bright: bool

Compatibility mode for legacy terminals that map bold to bright colors. When enabled, avoids using bold styling on text that would become bright colors, preventing visibility issues in terminals with “bold is bright” behavior.

§safe_colors_only: bool

Restrict color palette to the 11 “safe” ANSI colors portable across common themes. Safe colors: red, green, yellow, blue, magenta, cyan + brred, brgreen, brmagenta, brcyan Problematic colors avoided: brblack (invisible in Solarized Dark), bryellow (light themes), white/brwhite (light themes), brblue (Basic Dark). See: https://blog.xoria.org/terminal-colors/

§color_scheme_mode: ColorSchemeMode

Color scheme mode for automatic light/dark theme switching.

  • “auto”: Detect from terminal (via the Contour dark/light query where supported, else OSC 11, or the COLORFGBG env var) and follow live palette changes
  • “light”: Force light mode theme selection
  • “dark”: Force dark mode theme selection
§program_status: UiProgramStatusConfig

Opt-in terminal program status reports for the interactive TUI.

§notifications: UiNotificationsConfig

Notification preferences for attention events.

§fullscreen: UiFullscreenConfig

Fullscreen interaction settings for alternate-screen rendering.

§screen_reader_mode: bool

Screen reader mode: disables animations, uses plain text thinking indicators, and opens Transcript Review in raw mode. Alternate-screen compatibility depends on the terminal and assistive technology. Can also be enabled via VTCODE_SCREEN_READER=1 environment variable.

§reduce_motion_mode: bool

Reduce motion mode: keeps progress labels visible without animated effects. If omitted, defaults from VTCODE_REDUCE_MOTION, then a supported OS accessibility preference; unknown or unavailable preferences default to false.

§reduce_motion_keep_progress_animation: bool

Keep animated progress indicators while reduce_motion_mode is enabled. Screen reader mode still disables progress animation.

§hide_header: bool

Hide the full TUI header, showing only version info in a compact line.

§diff_preview_mode: DiffPreviewMode

Diff preview layout for file-edit approval overlays. Options: “inline” (default) or “side-by-side”.

§transcript_review: UiTranscriptReviewConfig

Transcript Review presentation controls.

Trait Implementations§

Source§

impl Clone for UiConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UiConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for UiConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UiConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for UiConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for UiConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more