Add Members

Add Members — CometChat documentation.

This component allows administrators or group owners to add new members to a specific group. It enables administrators or group owners to extend the membership of a group by adding new users to participate in the group’s discussions and activities. By utilising this feature, administrators can manage group membership, and control access to group content.

The administrator can select the desired users to be added to the group. This can be done by searching for specific users, selecting from a list of available users. The selected users will receive notifications to join the group.

Properties

Group Information

Details associated with the group.

Name	Type	Description
group	Group Class	Add members of this particular CometChat group

Title

Heading text for the component

Name	Type	Description
title	string	Heading text for the component
titleAlignment	string	Alignment of the heading text for the component

Search

This involves keywords, phrases, or criteria into the search bar and retrieving relevant results based on the search query.

Name	Type	Description
searchPlaceholder	string	Sample text that appears in the search input as a prompt or suggestion
searchIconURL	string	Asset URL for the search icon.
hideSearch	boolean	When set to true, hides the search input.

Section Header

Label or title of a specific section for the component

Name	Type	Description
sectionHeaderKey	string	Method of the user class to display the section header
showSectionHeader	boolean	When set to true, displays the header between the individual sections in the list.

Loading state

This refers to the state of the groups component when it is actively retrieving or fetching data.

Name	Type	Description
loadingIconURL	string	Asset URL for the loading indicator icon
loadingStateView	view	User-defined component to customise the loading indicator

Empty state

This refers to the state of the groups component when it has no content or data to display

Name	Type	Description
emptyStateText	string	The textual content displayed in the empty state of the component.
emptyStateView	view	User-defined component to customise the empty state of the component.

Error state

This refers to the state of the groups component when an error occurs during the retrieval of the data.

Name	Type	Description
errorStateText	string	The textual content displayed in the error state of the component.
errorStateView	view	User-defined component to customise the error state of the component.

RequestBuilder

This provides set of methods that allow developers to easily create and configure users before fetching them for the intended recipients.

Name	Type	Description
searchRequestBuilder	CometChat.UsersRequestBuilder	Class that allows you to set various parameters to the UsersRequest class based on which the users are searched
usersRequestBuilder	CometChat.UsersRequestBuilder	Class that allows you to set various parameters to the UsersRequest class based on which the users are fetched

Toggle

Switch to hide or show the separators, and error message.

Name	Type	Description
hideError	boolean	When set to true, hides the error messages displayed within the component
hideSeparator	boolean	When set to true, hides the separator between the individual elements in the list.
disableUsersPresence	boolean	When set to true, Users will not be able to see whether a particular user is currently online or offline.

selectionMode

Allows user to choose individual or multiple items.

Name	Type	Description
selectionMode	SelectionMode	Allows user to select individual or multiple items for applying specific operations.
onSelect	Function as PropType<(users:CometChat.User[]) => void>	Method invoked which returns the selected users.

Custom view

UI component created and customised by the developer to meet your design or functional requirements.

Name	Type	Description
subtitleView	Function as PropType<(user: CometChat.User) => ViewType>	User-defined component to customise the secondary text shown in the default user profile.

Menu

UI component created and customised by the developer to meet your design or functional requirements representing the button actions in the header section.

Name	Type	Description
menu	view	User-defined component to showcase options related to the group in the header section.

Actions

This includes action buttons or icons that allow users to perform common actions or tasks, such as muting the notification etc.

Name	Type	Description
options	Function as PropType<(user:CometChat.User) => CometChatOption[]>	User-defined actions which appears for each group on mouseover.

Function Callback

Functions that can be invoked by the user in response to a specific event or condition.

Name	Type	Description
onBack	Function as PropType<() => void>	Override the method that is invoked when the user clicks on the back button.
onError	Function as PropType<(error: CometChat.CometChatException) => void>	Override the method that is invoked when an error is encountered within the component

Misc

Name	Type	Description
backButtonIconURL	string	Asset URL for the back button icon
buttonText	string	Text displayed on the add members submit button
onAddMembersButtonClick	(guid:string, members:CometChat.User[]) => void	Override the method that is invoked when the user clicks on the add members submit button

Style

Styling properties and values of all the involved components

Name	Type	Description
avatarStyle	AvatarStyle	Styling properties and values of the Avatar component
statusIndicatorStyle	StatusIndicator	Styling properties and values of the StatusIndicator component
listItemStyle	ListItemStyle	Styling properties and values of the ListItem component
addMembersStyle	AddMembersStyle	Styling properties and values of the AddMembers component

Events

To handle events supported by CometChatAddMembers component you have to add the listeners mentioned here.

Vue

onBeforeMount(() => {

  CometChatGroupEvents.ccGroupMemberAdded.subscribe(({
messages: CometChat.Action[],usersAdded: CometChat.User[],userAddedIn:group,userAddedBy:user
}) => {
  //Proceed with UI updates
  });

});

onBeforeUnmount(() => {

  CometChatGroupEvents.ccGroupMemberAdded.unsubscribe();

});

Usage

Vue

//custom style properties
const addMembersStyle:AddMembersStyle =  new AddMembersStyle({
background:"",
border:"",
titleTextFont:"",
titleTextColor:"",
emptyStateTextFont:"",
emptyStateTextColor:"",
})

//apply custom styling to the CometChatAddMembers component
<CometChatAddMembers :addMembersStyle="addMembersStyle"></CometChatAddMembers>