CometChatGroupMembers
is a versatile Widget designed to showcase all users who are either added to or invited to a group, thereby enabling them to participate in group discussions, access shared content, and engage in collaborative activities. CometChatGroupMembers
have the capability to communicate in real-time through messaging, voice and video calls, and various other interactions. Additionally, they can interact with each other, share files, and join calls based on the permissions established by the group administrator or owner.
CometChatGroupMembers
widget is composed of the following BaseWidgets:
Widgets | Description |
---|---|
CometChatListBase | CometChatListBase serves as a container widget equipped with a title (navigationBar), search functionality (search-bar), background settings, and a container for embedding a list widget. |
CometChatListItem | This widget renders information extracted from a User object onto a tile, featuring a title, subtitle, leading widget, and trailing widget. experience, facilitating seamless navigation and interaction within the widget. |
CometChatGroupMembers
, as a Composite Widget, offers flexible integration options, allowing it to be launched directly via button clicks or any user-triggered action.
You can launch CometChatGroupMembers
directly using Navigator.push
, or you can define it as a widget within the build
method of your State
class.
CometChatGroupMembers
CometChatGroupMembers
as a Widget in the build MethodCometChatGroupMembers
, empowering them with greater control and customization options.
The onItemTap
action doesn’t have a predefined behavior. You can override this action using the following code snippet.
CometChatGroupMembers
, offering them enhanced control and flexibility in their interactions.
The onItemLongPress
action doesn’t have a predefined behavior. You can override this action using the following code snippet.
onBack
feature. This capability allows you to customize the behavior associated with navigating back within your app. Utilize the provided code snippet to override default behaviors and tailor the user experience according to your specific requirements.
onError
and improve error handling.
onSelection
event is triggered, it furnishes the list of selected members. This event can be invoked by any button or action within the interface. You have the flexibility to implement custom actions or behaviors based on the selected members.
This action does not come with any predefined behavior. However, you have the flexibility to override this event and tailor it to suit your needs using the following code snippet.
Widget
. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders
of Chat SDK.
Property | Description | Code |
---|---|---|
GUID | Group ID for the group whose members are to be fetched. | guid: String |
Limit | Number of results to limit the query. | limit: int? |
Search Keyword | Keyword for searching members within the group. | searchKeyword: String? |
Scopes | List of scopes for filtering members (e.g., moderators). | scopes: List<String>? |
GroupMembersProtocol
uses GroupsRequestBuilder enables you to filter and customize the search list based on available parameters in GroupsRequestBuilder.
This feature allows you to keep uniformity between the displayed Group Members List and Searched Group Members List.
Here is the complete example for reference:
Example
Widget
. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.
Events emitted by the Join Group widget is as follows.
Event | Description |
---|---|
ccGroupMemberBanned | Triggers when the group member banned from the group successfully |
ccGroupMemberKicked | Triggers when the group member kicked from the group successfully |
ccGroupMemberScopeChanged | Triggers when the group member scope is changed in the group |
GroupMembersStyle
to the CometChatGroupMembers
Widget to customize the styling.
GroupMemberStyle
Property | Description | Code |
---|---|---|
Background | Inherits from BaseStyles . Sets the background color or image of the widget. | background: Color? (inherited from BaseStyles ) |
Border | Inherits from BaseStyles . Sets the border of the widget. | border: Border? (inherited from BaseStyles ) |
Border Radius | Inherits from BaseStyles . Sets the border radius of the widget. | borderRadius: BorderRadius? (inherited from BaseStyles ) |
Empty Text Style | Style for the text displayed when the member list is empty. | emptyTextStyle: TextStyle? |
Error Text Style | Style for the text displayed when an error occurs. | errorTextStyle: TextStyle? |
Gradient | Inherits from BaseStyles . Sets a gradient for the background of the widget. | gradient: Gradient? (inherited from BaseStyles ) |
Height | Inherits from BaseStyles . Sets the height of the widget. | height: double? (inherited from BaseStyles ) |
List Padding | Padding applied to the list of group members. | listPadding: EdgeInsets? |
Loading Icon Tint | Tint color for the loading indicator icon. | loadingIconTint: Color? |
Member Scope Text Style | Style applied to the text displaying the member’s scope (e.g., moderator). | memberScopeTextStyle: TextStyle? |
Online Status Color | Color for the online status indicator of group members. | onlineStatusColor: Color? |
Search Background | Background color for the search bar. | searchBackground: Color? |
Search Border Color | Color for the border of the search bar. | searchBorderColor: Color? |
Search Border Radius | Border radius applied to the search bar. | searchBorderRadius: BorderRadius? |
Search Icon Tint | Tint color for the search icon. | searchIconTint: Color? |
Search Placeholder Style | Style applied to the placeholder text within the search bar. | searchPlaceholderStyle: TextStyle? |
Search Text Style | Style applied to the text entered in the search bar. | searchTextStyle: TextStyle? |
Separator Color | Color for the separator between group members in the list. | separatorColor: Color? |
Title Style | Style applied to the title text displayed at the top of the widget. | titleStyle: TextStyle? |
Width | Inherits from BaseStyles . Sets the width of the widget. | width: double? (inherited from BaseStyles ) |
Avatar
widget in the CometChatGroupMembers
Widget, you can use the following code snippet. For further insights on Avatar
Styles refer
CometChatGroupMembers
Widget, You can use the following code snippet. For further insights on Status Indicator Styles refer
List Item
widget in the CometChatGroupMembers
Widget, you can use the following code snippet. For further insights on List Item
Styles refer
CometChatGroupMembers
Property | Description | Code |
---|---|---|
Back Button | A custom widget to replace the default back button. | backButton: Widget? |
Hide Search | Hides the search bar for filtering group members (default: false). | hideSearch: bool (default: false) |
Hide Separator | Hides the separator between group members in the list. | hideSeparator: bool |
Search Box Icon | A custom icon to display in the search bar. | searchBoxIcon: Widget? |
Search Placeholder | Text displayed as a placeholder in the search bar. | searchPlaceholder: String? |
Selection Mode | Mode for selecting group members (e.g., single, multiple). | selectionMode: CometChatSelectionMode? |
Show Back Button | A boolean value indicating whether to show the back button (default: true). | showBackButton: bool (default: true) |
Empty State Text | Text displayed when the group member list is empty. | emptyStateText: String? |
Error State Text | Text displayed when an error occurs while fetching group members. | errorStateText: String? |
Hide Error | Hides the error state view when an error occurs. | hideError: bool |
Title | Title displayed at the top of the widget. | title: String? |
Disable Users Presence | A boolean value indicating whether to disable displaying the presence of group members (default: false). | disableUsersPresence: bool (default: false) |
Select Icon | A custom icon to display for the selection mode. | this.selectIcon: Widget? |
Submit Icon | A custom icon to display for the submit button. | this.submitIcon: Widget? |
CometChatGroupMembers
widget does not provide additional functionalities beyond this level of customization.
CometChatGroupMembers
Widget.
custom_list_item.dart
for more complex or unique list items.
appBarOptions
to the CometChatGroupMembers
widget.
CometChatGroupMembers
widget. You can add a Tail widget using the following method.
loadingStateView
to match the loading UI of your app.
EmptyStateView
using emptyStateView
to match the error UI of your app.
ErrorStateView
using errorStateView
to match the error UI of your app.