Skip to main content

ChatPopupStandaloneProps

Agent Runtimes

Agent Runtimes / chat/ChatPopupStandalone / ChatPopupStandaloneProps

Interface: ChatPopupStandaloneProps

Defined in: chat/ChatPopupStandalone.tsx:69

ChatPopupStandalone props

Properties​

animationDuration?​

optional animationDuration?: number

Defined in: chat/ChatPopupStandalone.tsx:164

Animation duration (in ms)

brandColor?​

optional brandColor?: string

Defined in: chat/ChatPopupStandalone.tsx:158

Brand color

brandIcon?​

optional brandIcon?: ReactNode

Defined in: chat/ChatPopupStandalone.tsx:149

Custom brand icon

buttonIcon?​

optional buttonIcon?: ReactNode

Defined in: chat/ChatPopupStandalone.tsx:152

Custom button icon when closed

buttonTooltip?​

optional buttonTooltip?: string

Defined in: chat/ChatPopupStandalone.tsx:155

Button tooltip text

children?​

optional children?: ReactNode

Defined in: chat/ChatPopupStandalone.tsx:146

Children to render in popup body (custom content)

className?​

optional className?: string

Defined in: chat/ChatPopupStandalone.tsx:128

Custom class name

clickOutsideToClose?​

optional clickOutsideToClose?: boolean

Defined in: chat/ChatPopupStandalone.tsx:122

Enable click outside to close

defaultOpen?​

optional defaultOpen?: boolean

Defined in: chat/ChatPopupStandalone.tsx:86

Default open state

description?​

optional description?: string

Defined in: chat/ChatPopupStandalone.tsx:80

Description shown in empty state

emptyStateMessage?​

optional emptyStateMessage?: string

Defined in: chat/ChatPopupStandalone.tsx:170

Empty state message

enableKeyboardShortcuts?​

optional enableKeyboardShortcuts?: boolean

Defined in: chat/ChatPopupStandalone.tsx:110

Enable keyboard shortcuts

enableStreaming?​

optional enableStreaming?: boolean

Defined in: chat/ChatPopupStandalone.tsx:167

Enable streaming mode

escapeToClose?​

optional escapeToClose?: boolean

Defined in: chat/ChatPopupStandalone.tsx:125

Enable escape key to close

height?​

optional height?: string | number

Defined in: chat/ChatPopupStandalone.tsx:92

Popup height

offset?​

optional offset?: number

Defined in: chat/ChatPopupStandalone.tsx:161

Offset from edge (in pixels)

onClose?​

optional onClose?: () => void

Defined in: chat/ChatPopupStandalone.tsx:143

Callback when popup closes

Returns​

void

onNewChat?​

optional onNewChat?: () => void

Defined in: chat/ChatPopupStandalone.tsx:137

Callback when new chat clicked

Returns​

void

onOpen?​

optional onOpen?: () => void

Defined in: chat/ChatPopupStandalone.tsx:140

Callback when popup opens

Returns​

void

onSendMessage​

onSendMessage: MessageHandler

Defined in: chat/ChatPopupStandalone.tsx:74

Handler for sending messages - REQUIRED. This function will be called when the user sends a message.

onSettingsClick?​

optional onSettingsClick?: () => void

Defined in: chat/ChatPopupStandalone.tsx:134

Callback when settings clicked

Returns​

void

panelProps?​

optional panelProps?: Partial<ChatBaseProps>

Defined in: chat/ChatPopupStandalone.tsx:179

Additional ChatBase props

placeholder?​

optional placeholder?: string

Defined in: chat/ChatPopupStandalone.tsx:131

Input placeholder

position?​

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

Defined in: chat/ChatPopupStandalone.tsx:83

Position of the popup

poweredByProps?​

optional poweredByProps?: Partial<PoweredByTagProps>

Defined in: chat/ChatPopupStandalone.tsx:119

Powered by tag props

renderToolResult?​

optional renderToolResult?: RenderToolResult

Defined in: chat/ChatPopupStandalone.tsx:176

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

showButton?​

optional showButton?: boolean

Defined in: chat/ChatPopupStandalone.tsx:98

Show the floating button when closed

showClearButton?​

optional showClearButton?: boolean

Defined in: chat/ChatPopupStandalone.tsx:104

Show clear button

showHeader?​

optional showHeader?: boolean

Defined in: chat/ChatPopupStandalone.tsx:95

Show header

showNewChatButton?​

optional showNewChatButton?: boolean

Defined in: chat/ChatPopupStandalone.tsx:101

Show new chat button

showPoweredBy?​

optional showPoweredBy?: boolean

Defined in: chat/ChatPopupStandalone.tsx:116

Show powered by tag

showSettingsButton?​

optional showSettingsButton?: boolean

Defined in: chat/ChatPopupStandalone.tsx:107

Show settings button

title?​

optional title?: string

Defined in: chat/ChatPopupStandalone.tsx:77

Popup title

toggleShortcut?​

optional toggleShortcut?: string

Defined in: chat/ChatPopupStandalone.tsx:113

Toggle shortcut key

width?​

optional width?: string | number

Defined in: chat/ChatPopupStandalone.tsx:89

Popup width