MessagingCanvas
A container which holds MessageInput and MessageList.
Can be themed with Theme.Chat.MessagingCanvas in Theme.
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 | Type | Description |
|---|---|---|
| Content | DynamicContentStore<MessagingCanvas.MessagingCanvasChildrenProps, MessagingCanvasChildrenKeys> | Dynamic content store |
| Input | MessageInput | Shortcut for MessageInput component |
| MessageList | MessageList | Shortcut for MessageList component |
| defaultProps | MessagingCanvas.MessagingCanvasProps | Default properties |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| sid | string | The identifier of the Chat channel or Conversation. | No | |
| inputDisabledReason | string | A reason on why the input element is disabled. | Yes | |
| avatarCallback | MessagingCanvas.AvatarCallback | A handler to request for avatar. | Yes | |
| memberDisplayOptions | MessagingCanvas.MemberDisplayOptions | Chat member display configuration. | Yes | |
| messageStyle | MessagingCanvas.MessageStyle | Identifies how the message should be displayed. | Yes | |
| showTypingIndicator | boolean | Should the typing indicator be shown. | Yes | |
| showReadStatus | boolean | Should the read status be shown. | Yes | |
| showTrayOnInactive | boolean | Should MessageTray to be shown when conversation is inactive. | Yes | |
| showWelcomeMessage | boolean | Should a welcome message to be shown. | Yes | |
| welcomeMessageText | CompiledTemplate | string representing the welcome message. | Yes | |
| charLimit | number | Identifies character limit for a single message. | Yes | |
| predefinedMessage | MessagingCanvas.PredefinedMessage | Defines the predefined, introductory message to be shown to a customer. | Yes | |
| hasMarkdownSupport | boolean | If set to true, messages bodies will be parsed as markdown. | Yes |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| conversation | ConversationState | state of conversation | Yes | |
| charLimit | number | character limit | Yes |