Skip to main content

ChatStandaloneProps

Agent Runtimes

Agent Runtimes / chat/ChatStandalone / ChatStandaloneProps

Interface: ChatStandaloneProps

Defined in: chat/ChatStandalone.tsx:42

ChatStandalone props

Properties​

animationDuration?​

optional animationDuration?: number

Defined in: chat/ChatStandalone.tsx:141

Animation duration (in ms)

brandColor?​

optional brandColor?: string

Defined in: chat/ChatStandalone.tsx:135

Brand color

brandIcon?​

optional brandIcon?: ReactNode

Defined in: chat/ChatStandalone.tsx:126

Custom brand icon

buttonIcon?​

optional buttonIcon?: ReactNode

Defined in: chat/ChatStandalone.tsx:129

Custom button icon when closed

buttonTooltip?​

optional buttonTooltip?: string

Defined in: chat/ChatStandalone.tsx:132

Button tooltip text

children?​

optional children?: ReactNode

Defined in: chat/ChatStandalone.tsx:123

Children to render in popup body (custom content)

className?​

optional className?: string

Defined in: chat/ChatStandalone.tsx:105

Custom class name

clickOutsideToClose?​

optional clickOutsideToClose?: boolean

Defined in: chat/ChatStandalone.tsx:99

Enable click outside to close

defaultOpen?​

optional defaultOpen?: boolean

Defined in: chat/ChatStandalone.tsx:63

Default open state

description?​

optional description?: string

Defined in: chat/ChatStandalone.tsx:57

Description shown in empty state

emptyStateMessage?​

optional emptyStateMessage?: string

Defined in: chat/ChatStandalone.tsx:147

Empty state message

enableKeyboardShortcuts?​

optional enableKeyboardShortcuts?: boolean

Defined in: chat/ChatStandalone.tsx:87

Enable keyboard shortcuts

enableStreaming?​

optional enableStreaming?: boolean

Defined in: chat/ChatStandalone.tsx:144

Enable streaming mode

escapeToClose?​

optional escapeToClose?: boolean

Defined in: chat/ChatStandalone.tsx:102

Enable escape key to close

height?​

optional height?: string | number

Defined in: chat/ChatStandalone.tsx:69

height

offset?​

optional offset?: number

Defined in: chat/ChatStandalone.tsx:138

Offset from edge (in pixels)

onClose?​

optional onClose?: () => void

Defined in: chat/ChatStandalone.tsx:120

Callback when popup closes

Returns​

void

onNewChat?​

optional onNewChat?: () => void

Defined in: chat/ChatStandalone.tsx:114

Callback when new chat clicked

Returns​

void

onOpen?​

optional onOpen?: () => void

Defined in: chat/ChatStandalone.tsx:117

Callback when popup opens

Returns​

void

onSendMessage​

onSendMessage: MessageHandler

Defined in: chat/ChatStandalone.tsx:51

Handler for sending messages - REQUIRED. This function will be called when the user sends a message. Signature: (message, messages, options?) => Promise<string | void>

  • message: The user's message text
  • messages: All messages in the conversation (including the new user message)
  • options: Streaming callbacks (onChunk, onComplete, onError, signal)

onSettingsClick?​

optional onSettingsClick?: () => void

Defined in: chat/ChatStandalone.tsx:111

Callback when settings clicked

Returns​

void

panelProps?​

optional panelProps?: Partial<ChatBaseProps>

Defined in: chat/ChatStandalone.tsx:162

Additional ChatBase props

pendingPrompt?​

optional pendingPrompt?: string

Defined in: chat/ChatStandalone.tsx:159

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/ChatStandalone.tsx:108

Input placeholder

position?​

optional position?: "bottom-right" | "bottom-left" | "top-right" | "top-left"

Defined in: chat/ChatStandalone.tsx:60

Position of the popup

poweredByProps?​

optional poweredByProps?: Partial<PoweredByTagProps>

Defined in: chat/ChatStandalone.tsx:96

Powered by tag props

renderToolResult?​

optional renderToolResult?: RenderToolResult

Defined in: chat/ChatStandalone.tsx:153

Custom render function for tool results. When provided, tool calls will be rendered inline in the chat.

showButton?​

optional showButton?: boolean

Defined in: chat/ChatStandalone.tsx:75

Show the floating button when closed

showClearButton?​

optional showClearButton?: boolean

Defined in: chat/ChatStandalone.tsx:81

Show clear button

showHeader?​

optional showHeader?: boolean

Defined in: chat/ChatStandalone.tsx:72

Show header

showNewChatButton?​

optional showNewChatButton?: boolean

Defined in: chat/ChatStandalone.tsx:78

Show new chat button

showPoweredBy?​

optional showPoweredBy?: boolean

Defined in: chat/ChatStandalone.tsx:93

Show powered by tag

showSettingsButton?​

optional showSettingsButton?: boolean

Defined in: chat/ChatStandalone.tsx:84

Show settings button

title?​

optional title?: string

Defined in: chat/ChatStandalone.tsx:54

title

toggleShortcut?​

optional toggleShortcut?: string

Defined in: chat/ChatStandalone.tsx:90

Toggle shortcut key

width?​

optional width?: string | number

Defined in: chat/ChatStandalone.tsx:66

width