ChatSurfaces
Page
Chat Page from the Chat package.
Loading ChatPage…
Source code
Waiting for the preview before loading source files · 2 of 2
Properties
Public properties derived from the component’s TypeScript signature.
| Property | Type | Default |
|---|---|---|
deviceOptional | "desktop" | "tablet" | "mobile" | — |
pageTitleOptional | string | "Chat" |
queueOptional | Omit<QueueProps, "messages"> | — |
allowSubmitWhileBusyOptional | boolean | — |
attachmentsOptional | readonly File[] | — |
branchLabelOptional | string | — |
composerAccessoryOptionalCompact contextual content rendered immediately above the composer. | ReactNode | — |
composerFooterOptionalContent immediately below the composer, such as account usage limits. | ReactNode | — |
customizeOptional | UiCustomization | — |
descriptionOptional | string | — |
disabledOptional | boolean | — |
emptyDescriptionOptional | string | — |
emptyTitleOptional | string | — |
inputValueRequired | string | — |
loadingOptionalShows a quiet thread skeleton while persisted conversation data is loading. | boolean | — |
headerActionsOptional | readonly ChatAction[] | — |
headerItemsOptional | readonly ChatContextItem[] | — |
messagesRequired | readonly ChatMessageData[] | — |
onAttachmentsChangeOptional | ((attachments: readonly File[]) => void) | — |
onAttachmentSelectOptional | (() => void) | — |
onInputChangeRequired | (value: string) => void | — |
onHeaderActionSelectOptional | ((action: ChatAction) => void) | — |
onFormSubmitOptional | ((submission: ChatFormSubmission) => void) | — |
onNavigationActionSelectOptional | ((action: ChatAction) => void) | — |
onStopOptional | (() => void) | — |
onSubmitRequired | (value: string, attachments: readonly File[], mode: ChatSubmitMode) => void | — |
onSuggestionSelectOptional | ((suggestion: ChatSuggestion) => void) | — |
onThreadSelectOptional | ((thread: ChatThreadData) => void) | — |
onThreadSectionExpandedChangeOptional | ((sectionId: string, expanded: boolean) => void) | — |
placeholderOptional | string | — |
queueSubmitLabelOptional | string | — |
railSectionsOptional | readonly ChatRailSection[] | — |
getMessageGroupKeyOptional | ((message: ChatMessageData) => string | undefined) | — |
renderMessageOptional | ((message: ChatMessageData) => ReactNode) | — |
renderMessageGroupOptional | ((messages: readonly ChatMessageData[]) => ReactNode) | — |
sidebarActionsOptional | readonly ChatAction[] | — |
sidebarFooterActionsOptional | readonly ChatAction[] | — |
sidebarTitleOptional | string | — |
stateOptional | "error" | "idle" | "streaming" | "waiting" | — |
statusItemOptional | ChatContextItem | — |
stopLabelOptional | string | — |
submitLabelOptional | string | — |
submitModeOptional | "send" | "steer" | — |
queueSubmitShortcutOptional | boolean | — |
suggestionsOptional | readonly ChatSuggestion[] | — |
systemItemsOptional | readonly ChatContextItem[] | — |
threadLabelOptional | string | — |
threadSectionsOptional | readonly ChatThreadSection[] | — |
threadsOptional | readonly ChatThreadData[] | — |
expandedThreadSectionIdsOptional | ReadonlySet<string> | — |
defaultExpandedThreadSectionIdsOptional | ReadonlySet<string> | — |
titleOptional | string | — |
toolbarControlsOptional | readonly ChatComposerControl[] | — |
workspaceLabelOptional | string | — |