CometChatDetails
is a component that provides additional information and settings related to a specific group.
The details screen includes the following elements and functionalities:
Name | Type | Description |
---|---|---|
group | CometChat.Group | View details of this particular CometChat group |
Name | Type | Description |
---|---|---|
title | string | Heading text for the component |
Name | Type | Description |
---|---|---|
privateGroupIcon | string | Asset URL for the icon representing private groups |
protectedGroupIcon | string | Asset URL for the icon representing password protected groups |
closeButtonIconURL | string | Asset URL for the close icon |
Name | Type | Description |
---|---|---|
data | CometChatDetailsTemplate | Data model that serve as a starting point of the details component for a particular user |
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. |
customProfileView | Function as PropType<(user?: CometChat.User) => ViewType> | User-defined component to customise user profile view. |
Name | Type | Description |
---|---|---|
hideProfile | boolean | When set to true, the user profile view will be hidden |
Name | Type | Description |
---|---|---|
onClose | Function as PropType<() => void> | Override the method that is invoked when user clicks on the close icon. |
onError | Function as PropType<(error: CometChat.CometChatException) => void> | Override the method that is invoked when an error is encountered within the details component |
Name | Type | Description |
---|---|---|
groupMembersConfiguration | GroupMembersConfiguration | Configurable properties of the CometChatGroupMembers component |
addMembersConfiguration | AddMembersConfiguration | Configurable properties of the CometChatAddMembers component |
bannedMembersConfiguration | BannedMembersConfiguration | Configurable properties of the CometChatBannedMembers component |
transferOwnershipConfiguration | TransferOwnershipConfiguration | Configurable properties of the CometChatTransferOwnership component |
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 |
leaveDialogStyle | ConfirmDialogStyle | Styling properties and values of the ConfirmDialog component |
detailsStyle | DetailsStyle | Styling properties and values of the Details component |