MessagingCanvas
A container which holds MessageInput and MessageList Can be themed with [theme.Chat.MessagingCanvas]{@link MessagingCanvas.MessagingCanvasThemeProps}
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| list | MessageList | Message list. Displays the `MessageList` component | ||
| input | MessageInput | Message input. Displays the `MessageInput` component | ||
| tray | MessageCanvasTray | Visible only if `showTrayOnInactive` prop is true and the channel is inactive | Message canvas tray. Displays the `MessageCanvasTray` component for webchat |
Static Properties#
| Name | Description | Type |
|---|---|---|
| Content | Dynamic content store | DynamicContentStore.<MessagingCanvas.MessagingCanvasChildrenProps> |
| Input | Shortcut for MessageInput component | MessageInput |
| MessageList | Shortcut for MessageList component | MessageList |
| defaultProps | Default properties | MessagingCanvas.MessagingCanvasProps |
Component Properties
sid: stringA unique identifier of the message.
inputDisabledReason?: stringA reason on why the input element is disabled.
avatarCallback?: MessagingCanvas.AvatarCallbackA handler to request for avatar.
memberDisplayOptions?: MessagingCanvas.MemberDisplayOptionsChat member display configuration.
messageStyle?: MessagingCanvas.MessageStyleIdentifies how the message should be displayed.
showTypingIndicator?: booleanShould the typing indicator be shown.
showReadStatus?: booleanShould the read status be shown.
showTrayOnInactive?: booleanShould MessageTray to be shown when conversation is inactive.
showWelcomeMessage?: booleanShould a welcome message to be shown.
welcomeMessageText?: CompiledTemplatestring representing the welcome message.
charLimit?: numberIdentifies character limit for a single message.
predefinedMessage?: MessagingCanvas.PredefinedMessageDefines the predefined, introductory message to be shown to a customer.
autoInitConversation?: MessagingCanvas.autoInitConversationShould the component automatically initialize conversation if not initialized already.
hasMarkdownSupport?: booleanIf set to true, messages bodies will be parsed as markdown.