Skip to main content

ChatSidebarProps

Agent Runtimes

Agent Runtimes / chat/ChatSidebar / ChatSidebarProps

Interface: ChatSidebarProps

Defined in: chat/ChatSidebar.tsx:45

ChatSidebar props

Properties​

brandIcon?​

optional brandIcon?: ReactNode

Defined in: chat/ChatSidebar.tsx:118

Custom brand icon

children?​

optional children?: ReactNode

Defined in: chat/ChatSidebar.tsx:115

Children to render in sidebar body (custom content)

className?​

optional className?: string

Defined in: chat/ChatSidebar.tsx:100

Custom class name

clickOutsideToClose?​

optional clickOutsideToClose?: boolean

Defined in: chat/ChatSidebar.tsx:94

Enable click outside to close

defaultOpen?​

optional defaultOpen?: boolean

Defined in: chat/ChatSidebar.tsx:61

Initial open state

description?​

optional description?: string

Defined in: chat/ChatSidebar.tsx:134

Description shown in empty state

enableKeyboardShortcuts?​

optional enableKeyboardShortcuts?: boolean

Defined in: chat/ChatSidebar.tsx:82

Enable keyboard shortcuts

enableStreaming?​

optional enableStreaming?: boolean

Defined in: chat/ChatSidebar.tsx:128

Enable streaming mode (default: true)

escapeToClose?​

optional escapeToClose?: boolean

Defined in: chat/ChatSidebar.tsx:97

Enable escape key to close

onClose?​

optional onClose?: () => void

Defined in: chat/ChatSidebar.tsx:112

Callback when sidebar closes

Returns​

void

onNewChat?​

optional onNewChat?: () => void

Defined in: chat/ChatSidebar.tsx:106

Callback when new chat clicked

Returns​

void

onOpen?​

optional onOpen?: () => void

Defined in: chat/ChatSidebar.tsx:109

Callback when sidebar opens

Returns​

void

onSendMessage?​

optional onSendMessage?: MessageHandler

Defined in: chat/ChatSidebar.tsx:125

Handler for sending messages. When provided, this is used instead of protocol mode. Signature: (message, messages, options?) => Promise<string | void>

onSettingsClick?​

optional onSettingsClick?: () => void

Defined in: chat/ChatSidebar.tsx:103

Callback when settings clicked

Returns​

void

panelProps?​

optional panelProps?: Partial<ChatBaseProps>

Defined in: chat/ChatSidebar.tsx:143

Additional ChatBase props

pendingPrompt?​

optional pendingPrompt?: string

Defined in: chat/ChatSidebar.tsx:140

A prompt to append and send after the conversation history is loaded. The message is shown in the chat and sent to the agent exactly once.

placeholder?​

optional placeholder?: string

Defined in: chat/ChatSidebar.tsx:131

Input placeholder

position?​

optional position?: "left" | "right"

Defined in: chat/ChatSidebar.tsx:64

Sidebar position

poweredByProps?​

optional poweredByProps?: Partial<PoweredByTagProps>

Defined in: chat/ChatSidebar.tsx:91

Powered by tag props

protocol?​

optional protocol?: Protocol | ProtocolConfig

Defined in: chat/ChatSidebar.tsx:58

Protocol type or full configuration.

When a Protocol string is provided (e.g. 'vercel-ai'), it is forwarded to ChatBase. When a full ProtocolConfig object is provided, it is passed directly via panelProps.

Default​

'vercel-ai'

showClearButton?​

optional showClearButton?: boolean

Defined in: chat/ChatSidebar.tsx:76

Show clear button

showHeader?​

optional showHeader?: boolean

Defined in: chat/ChatSidebar.tsx:70

Show header

showNewChatButton?​

optional showNewChatButton?: boolean

Defined in: chat/ChatSidebar.tsx:73

Show new chat button

showPoweredBy?​

optional showPoweredBy?: boolean

Defined in: chat/ChatSidebar.tsx:88

Show powered by tag

showSettingsButton?​

optional showSettingsButton?: boolean

Defined in: chat/ChatSidebar.tsx:79

Show settings button

title?​

optional title?: string

Defined in: chat/ChatSidebar.tsx:47

Sidebar title

toggleShortcut?​

optional toggleShortcut?: string

Defined in: chat/ChatSidebar.tsx:85

Keyboard shortcut to toggle (default: 'k')

width?​

optional width?: string | number

Defined in: chat/ChatSidebar.tsx:67

Sidebar width when open