Activate Selection | Used to specify if the listed conversations can be selected, selection can be activated on tap or on long press | activateSelection: ActivateSelection |
AppBar Options | Used to set the options available in the app bar | appBarOptions: List<Widget> |
Back Button | Used to set back button located in the app bar | backButton: Widget |
Controller | Used to programmatically update the scroll physics of list containing the conversations | controller: ScrollController |
Date Pattern | Used to display a custom string instead of the timestamp show at the tail of the conversation item | datePattern: String Function(Conversation conversation) |
Disable Mentions | Disables mentions formatter if true | disableMentions: bool |
Disable Typing | If true stops indicating if a participant in a conversation is typing | disableTyping: bool |
Empty State Text | Used to set a custom text response when fetching the conversations has returned an empty list | emptyStateText: String |
Error State Text | Used to set a custom text response when some error occurs on fetching the list of conversations | errorStateText: String |
Hide Appbar | Toggle visibility for app bar | hideAppbar: bool |
Hide Error | Used to hide error on fetching conversations | hideError: bool |
Hide Search | Used to toggle visibility for search box | hideSearch: bool |
Hide Separator | Used to hide the divider separating the conversation items | hideSeparator: bool |
Hide Section Separator | Used to hide the text separating grouped conversation items | hideSectionSeparator: bool |
Options | Used to set options affecting the conversation item in some way | options: List<CometChatOption> Function(Conversation, BuildContext) |
On Back | Used to set a call back triggered on tapping the back button in the app bar | onBack: VoidCallback |
On Error | Used to set a callback triggered in case any error happens when fetching conversations | onError: OnError |
On Item Long Press | Used to set a callback that would be triggered on long press on a conversation item | onItemLongPress: Function(Conversation) |
On Item Tap | Used to set a callback that would be triggered on tapping a conversation item | onItemTap: Function(Conversation) |
On Selection | Used to set a custom callback that would utilize the selected conversations to execute some task | onSelection: Function(List<Conversation>, BuildContext) |
Poperties | Types | Description |
Private Group Icon | Used to set icon shown in place of status indicator if the conversation is taking place in a private group | privateGroupIcon: Widget |
Protected Group Icon | Used to set icon shown in place of status indicator if the conversation is taking place in a password protected group | protectedGroupIcon: Widget |
Receipt Style | Used to customize the colors of receipt icons shown in the subtitle of the conversation item if hideReceipt is false | receiptStyle: ReceiptStyle |
Search Box Icon | Used to set search Icon in the search field | searchBoxIcon: Widget |
Search Placeholder | Used to set placeholder text for the search field | searchPlaceholder: String |
Selection Icon | Change selection icon | selectionIcon: Widget |
Sent Icon | Used to customize the receipt icon shown in the subtitle of the conversation item if hideReceipt is false and if the status of the last message in the conversation is sent | sentIcon: Widget |
Show Back Button | Used to toggle visibility for back button | showBackButton: bool |
State CallBack | Used to set a callback that can be used to retrieve the business logic (an instance of CometChatConversationsController) of the widget, with which the parent widget of CometChatConversations can access the public methods available in the business logic widget | stateCallBack: Function(CometChatConversationsController) |
Status Indicator Style | Used to customise the status indicator shown if a user is online | statusIndicatorStyle: StatusIndicatorStyle |
Subtitle View | Used to set a custom subtitle for every conversation item | subtitleView: Widget Function(BuildContext, Conversation) |
Tail View | Used to generate a custom trailing view for the conversation item, by default it shows the time sent of the last message and the unread messages count | tailView: Widget Function(Conversation) |
Text Formatters | Used to pass a list of text formatters to format the text shown in text subtitle of each conversation provided the last message is a text message and it contains mentions | textFormatters: List<CometChatTextFormatter> |
Theme | Used to set custom theme | theme: CometChatTheme |
Title | Used to set the title in the app bar | title: String |
Typing Indicator Text | Used to customize the text response shown in the subtitle of the conversation item if a participant of a conversation is typing | typingIndicatorText: String |