Skip to main content

ChatBaseHeaderProps

Agent Runtimes

Agent Runtimes / chat/header/ChatHeaderBase / ChatBaseHeaderProps

Interface: ChatBaseHeaderProps

Defined in: src/chat/header/ChatHeaderBase.tsx:82

Properties​

brandIcon?​

optional brandIcon?: ReactNode

Defined in: src/chat/header/ChatHeaderBase.tsx:85

chatViewMode?​

optional chatViewMode?: ChatViewMode

Defined in: src/chat/header/ChatHeaderBase.tsx:122

Current chat view mode

enableEphemeralDocumentOption?​

optional enableEphemeralDocumentOption?: boolean

Defined in: src/chat/header/ChatHeaderBase.tsx:130

Whether the Document option is available in the surface control.

enableEphemeralNotebookOption?​

optional enableEphemeralNotebookOption?: boolean

Defined in: src/chat/header/ChatHeaderBase.tsx:128

Whether the Notebook option is available in the surface control.

ephemeralSurfaceMode?​

optional ephemeralSurfaceMode?: EphemeralSurfaceMode

Defined in: src/chat/header/ChatHeaderBase.tsx:132

Current companion-surface mode.

headerActions?​

optional headerActions?: ReactNode

Defined in: src/chat/header/ChatHeaderBase.tsx:87

headerButtons?​

optional headerButtons?: HeaderButtonsConfig

Defined in: src/chat/header/ChatHeaderBase.tsx:114

Header button configuration

headerContent?​

optional headerContent?: ReactNode

Defined in: src/chat/header/ChatHeaderBase.tsx:86

kernel?​

optional kernel?: IKernelConnection | null

Defined in: src/chat/header/ChatHeaderBase.tsx:104

Live kernel connection from the notebook runtime. When provided, the chat header renders the same <KernelIndicator> as the notebook toolbar — subscribing to the kernel's live signals so the colour and tooltip stay in sync with the notebook indicator.

kernelCpu?​

optional kernelCpu?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:108

Optional CPU info shown in indicator details.

kernelEnvironmentName?​

optional kernelEnvironmentName?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:106

Optional environment name shown in indicator details.

kernelGpu?​

optional kernelGpu?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:112

Optional GPU info shown in indicator details.

kernelIndicatorState?​

optional kernelIndicatorState?: ExecutionState

Defined in: src/chat/header/ChatHeaderBase.tsx:92

Optional kernel indicator state override from notebook runtime.

kernelMemory?​

optional kernelMemory?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:110

Optional memory info shown in indicator details.

messageCount​

messageCount: number

Defined in: src/chat/header/ChatHeaderBase.tsx:116

Current count of messages (used to conditionally show clear button)

onChatViewModeChange?​

optional onChatViewModeChange?: (mode) => void

Defined in: src/chat/header/ChatHeaderBase.tsx:124

Callback when view mode changes

Parameters​

mode​

ChatViewMode

Returns​

void

onClear​

onClear: () => void

Defined in: src/chat/header/ChatHeaderBase.tsx:120

Callback when clear is triggered

Returns​

void

onEphemeralSurfaceModeChange?​

optional onEphemeralSurfaceModeChange?: (mode) => void

Defined in: src/chat/header/ChatHeaderBase.tsx:134

Callback fired when the user changes the companion-surface mode.

Parameters​

mode​

EphemeralSurfaceMode

Returns​

void

onInformationClick?​

optional onInformationClick?: () => void

Defined in: src/chat/header/ChatHeaderBase.tsx:89

Returns​

void

onNewChat​

onNewChat: () => void

Defined in: src/chat/header/ChatHeaderBase.tsx:118

Callback when new chat is triggered

Returns​

void

padding​

padding: number

Defined in: src/chat/header/ChatHeaderBase.tsx:90

runtimeStatus?​

optional runtimeStatus?: RuntimeStatus | null

Defined in: src/chat/header/ChatHeaderBase.tsx:97

Runtime status from agent-runtimes sandbox status stream. Uses the same execution-state model as KernelIndicator.

showEphemeralSurfaceControl?​

optional showEphemeralSurfaceControl?: boolean

Defined in: src/chat/header/ChatHeaderBase.tsx:126

Show the companion-surface segmented control (None / Notebook / Document).

showInformation?​

optional showInformation?: boolean

Defined in: src/chat/header/ChatHeaderBase.tsx:88

subtitle?​

optional subtitle?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:84

title?​

optional title?: string

Defined in: src/chat/header/ChatHeaderBase.tsx:83