Description of icon
Flex UI
API Reference

MessageCanvasTray

A container used when the status of the channel is inactive. Can be themed with Theme.Chat.MessageCanvasTray in Theme.


Component children#

KeyComponentConditionAlignDescription
textReact component
Message canvas tray template. Displays MessageCanvasTrayContent template
buttonstyled(button)
Visible only if showButton prop is true
Message canvas tray button to start a new chat. The button text is the MessageCanvasTrayButton template

Static Properties#

NameTypeDescription
ContentDynamicContentStore<MessageCanvasTray.MessageCanvasTrayProps, MessageCanvasTrayChildrenKeys>

Dynamic content store

defaultPropsMessageCanvasTray.MessageCanvasTrayProps

Default properties

Component Properties#

NameTypeDescriptionOptionalDefault
showButtonboolean

Display a ‘Start new chat’ button in the tray.

Yestrue
onButtonClickfunction

A handler for a ‘Start new chat’ button click.

Yes
Rate this page

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.