CometChatAddMembers
is a Widget that empowers administrators or group owners with the ability to expand group membership by seamlessly adding new participants. This widget facilitates effortless management of group membership and enhances collaboration within the group’s discussions and activities. Administrators can meticulously select desired users to join the group, whether by targeted search or from a list of available users. Selected users receive notifications, streamlining the process of joining the group and ensuring smooth integration into the community.
CometChatAddMembers
widget is composed of the following BaseWidgets:
Widgets | Description |
---|---|
CometChatUsers | CometChatUsers is a standalone widget that presents a user list and enables targeted user searches. As a container inheriting from CometChatListBase , it seamlessly incorporates the CometChatUserList widget. This setup streamlines user browsing and search capabilities, enhancing overall usability and facilitating efficient interactions. |
CometChatListItem | This widget renders information extracted from a User object onto a tile, featuring a title, subtitle, leading view, and trailing view. experience, facilitating seamless navigation and interaction within the widget. |
CometChatAddMembers
, as a Composite Widget, offers flexible integration options, allowing it to be launched directly via button clicks or any user-triggered action. Additionally, it seamlessly integrates into tab view controllers. With add members, users gain access to a wide range of parameters and methods for effortless customization of its user interface.
You can launch CometChatAddMembers
directly using Navigator.push
, or you can define it as a widget within the build
method of your State
class.
CometChatAddMembers
CometChatAddMembers
as a Widget in the build MethodonBack
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 users. 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 users.
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 |
---|---|---|
Friends Only | Indicates if the request is limited to friends. | friendsOnly: bool? |
Hide Blocked Users | Whether to hide blocked users in the request. | hideBlockedUsers: bool? |
Limit | Maximum number of users to fetch. | limit: int? |
Role | Specific role of the users to fetch. | role: String? |
Roles | List of roles for the users. | roles: List<String>? |
Search Keyword | Keyword for searching users. | searchKeyword: String? |
Tags | List of tags associated with the users. | tags: List<String>? |
Uids | List of user IDs. | uids: List<String>? |
User Status | Status of the user. | userStatus: String? |
With Tags | Whether to include users with specific tags. | withTags: bool? |
UsersProtocol
uses UsersRequestBuilder enables you to filter and customize the search list based on available parameters in UsersRequestBuilder. This feature allows you to keep uniformity between the displayed User List and searched User List.
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 |
---|---|
ccGroupMemberAdded | Triggers when a user added to a group successfully |
CometChatAddMembers
widget in the Group Member Widget, you can use the following code snippet.
AddMembersStyle
Property | Description | Code |
---|---|---|
Back Icon Tint | Tint color for the back icon. | backIconTint: Color? |
Background | Background color or decoration. | background: Decoration? |
Border | Border of the widget. | border: Border? |
Border Radius | Radius of the widget’s border. | borderRadius: BorderRadius? |
Close Icon Tint | Tint color for the close icon. | closeIconTint: Color? |
Empty State Text Style | Style for the empty state text. | emptyStateTextStyle: TextStyle? |
Error State Text Style | Style for the error state text. | errorStateTextStyle: TextStyle? |
Gradient | Gradient used for the widget’s background. | gradient: Gradient? |
Height | Height of the widget. | height: double? |
Placeholder Style | Style for the placeholder text. | placeholderStyle: TextStyle? |
Search Background | Background color or decoration for the search. | searchBackground: Decoration? |
Search Border Color | Color of the search field’s border. | searchBorderColor: Color? |
Search Border Radius | Radius of the search field’s border. | searchBorderRadius: BorderRadius? |
Search Border Width | Width of the search field’s border. | searchBorderWidth: double? |
Search Icon Tint | Tint color for the search icon. | searchIconTint: Color? |
Search Style | Style for the search text. | searchStyle: TextStyle? |
Selection Icon Tint | Tint color for the selection icon. | selectionIconTint: Color? |
Submit Icon Tint | Tint color for the submit icon. | submitIconTint: Color? |
Title Style | Style for the title text. | titleStyle: TextStyle? |
Width | Width of the widget. | width: double? |
Avatar
widget in the CometChatAddMembers
Widget, you can use the following code snippet. For further insights on Avatar
Styles refer
CometChatAddMembers
Widget, You can use the following code snippet. For further insights on Status Indicator Styles refer
ListItemStyle
in the CometChatAddMembers
Widget, you can use the following code snippet. For further insights on List Item
Styles refer
CometChatAddMembers
Property | Description | Code |
---|---|---|
Back Button | Custom widget for the back button. | backButton: Widget? |
Disable Users Presence | Option to disable displaying users’ presence. | disableUsersPresence: bool? |
Empty State Text | Text to display when there are no members. | emptyStateText: String? |
Error State Text | Text to display when there is an error. | errorStateText: String? |
Hide Error | Option to hide error messages. | hideError: bool? |
Hide Search | Option to hide the search bar. | hideSearch: bool |
Hide Separator | Option to hide item separators in the list. | hideSeparator: bool? |
Search Icon | Custom widget for the search icon. | searchIcon: Widget? |
Search Placeholder | Placeholder text for the search bar. | searchPlaceholder: String? |
Selection Icon | Custom widget for the selection icon. | selectionIcon: Widget? |
Show Back Button | Option to show or hide the back button. | showBackButton: bool |
Submit Icon | Custom widget for the submit icon. | submitIcon: Widget? |
Title | Title text for the widget. | title: String? |
CometChatAddMembers
widget does not provide additional functionalities beyond this level of customization.
CometChatAddMembers
Widget.
custom_list_item.dart
for more complex or unique list items.
appBarOptions
to the CometChatAddMembers
widget.
EmptyStateView
using emptyStateView
to match the error widget of your app.
loadingStateView
to match the loading UI of your app.
ErrorStateView
using errorStateView
to match the error UI of your app.