MessageListConfiguration
This refers to the properties of the CometChatMessageList component that are available for customisation via the parent component when the component exists in a deep nested hierarchy.
Configurable Properties
| Name | Description |
|---|---|
| messagesRequestBuilder | Class that allows you to set various parameters to the MessagesRequest class based on which the messages are fetched |
| templates | This refers to the structure each message will take form or shape of. It defaults to templates for 5 message type i.e. text, audio, video, image, files including the supported extensions. |
| alignment | This refers to the visual arrangement or positioning of the message bubble within the message list. Defaults to standard alignment i.e. Sent messages aligned to right and received messages aligned to left. |
| timestampAlignment | This refers to the visual arrangement or positioning of the message timestamp within the message list. Defaults to top alignment. |
| loadingIconURL | Asset URL for the loading indicator icon |
| loadingStateView | User-defined component to customise the loading indicator |
| emptyStateView | User-defined component to customise the empty state of the component. |
| errorStateView | User-defined component to customise the error state of the component. |
| waitIcon | Asset URL for the wait state indicating that a sent message is in transit. |
| sentIcon | Asset URL for the sent state indicating that a message is sent successfully. |
| deliveredIcon | Asset URL for the delivered state indicating that a sent message is delivered successfully. |
| readIcon | Asset URL for the read state indicating that a sent message is read by the receiver. |
| errorIcon | Asset URL for the error state indicating that an error has occurred when the message was in transit. |
| headerView | User-defined component to customise the top of the message list component. You can customise it to contain important information, branding elements, or navigation controls. It defaults to an empty view. |
| footerView | User-defined component to customise the bottom of the message list component. You can customise it to contain supplementary information, navigation links, or actions. By default, it shows quick reply options to a user when the Smart Replies extension is enabled. |
| datePattern | User defined date format for the timestamp displayed for each message bubble. |
| DatePatterns | User defined date format of the delimiters used to separate the message bubbles. |
| showAvatar | When set to true, it will display avatar for both the sender and recipient of the message. |
| hideError | When set to true, hides the error message when an error is encountered in the component |
| disableReceipt | When set to true, switches off the visual indication when a message has been read or viewed by the recipient. |
| scrollToBottomOnNewMessages | When set to true, the message list scrolls to the bottom automatically upon receiving a message instead of showing a scroll-to-bottom button. |
| disableSoundForMessages | When set to true, the component will not produce sound for all incoming messages. |
| customSoundForMessages | mp3 file asset of your choice. |
| onThreadRepliesClick | Override the method that is invoked when a threaded conversation is clicked in the message list. |
| onError | Override the method that is invoked when an error is encountered within the details component |
| avatarStyle | Styling properties and values of the Avatar component |
| statusIndicatorStyle | Styling properties and values of the StatusIndicator component |
| backdropStyle | Styling properties and values of the Backdrop component |
| messageListStyle | Styling properties and values of the CometChatMessageList component |
| disableMentions | Disables mentions in message list. Default value is set to false |
| reactionsConfiguration | Properties reactions that are available for customisation via the messages component. |
| disableReactions | Disables reactions in message list |
| emojiKeyboardStyle | Styling properties for customization of emoji keyboard |
| threadIndicatorIcon | Accepts asset file/url for threadIndicatorIcon |
| textFormattersList | Accepts custom text formatters for message list |