Enhance documentation for Mentions and add Report Message feature det… by swayam-cometchat · Pull Request #161 · cometchat/docs

swayam-cometchat · 2025-12-02T12:55:35Z

…ails

Description

Related Issue(s)

Type of Change

Checklist

I have read the CONTRIBUTING document
My branch name follows the naming convention
My changes follow the documentation style guide
I have checked for spelling and grammar errors
All links in my changes are valid and working
My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

…ails

suraj-chauhan-cometchat · 2026-10-16T09:52:56Z

 | **hideGroupActionMessages**    | used to toggle visibility of hide group action info option in MessageList                                                                          | `hideGroupActionMessages={true}`                          |
 | **hideTimestamp**              | used to toggle visibility of hide timestamp in MessageList                                                                                         | `hideTimestamp={true}`                                    |
+| **hideFlagMessageOption**         | Hides the "Report Message" option from message actions menu.                                  | `hideFlagMessageOption={true}`                 |
+| **hideFlagMessageOption**           | Hides the remark text area in the flag message dialog.                                             | `hideFlagRemarkField={true}`                   |


Bug: duplicate prop name. This row is named hideFlagMessageOption again, but it describes the remark field and its example uses hideFlagRemarkField, which is the real prop (CometChatMessageList.tsx:538). A reader who copies the bold name will hide the whole Report option instead of just the remark field.

Suggested change

| **hideFlagMessageOption** | Hides the remark text area in the flag message dialog. | `hideFlagRemarkField={true}` |

| **hideFlagRemarkField** | Hides the remark text area in the flag message dialog. | `hideFlagRemarkField={true}` |

suraj-chauhan-cometchat · 2026-10-16T09:52:57Z


-Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation.
-
+Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. The feature also supports group mentions like @all, enabling users to quickly notify all members in a group chat simultaneously.


MDX: the blank line before <Frame> was removed. Without it, MDX treats <Frame> as a lazy continuation of the paragraph and nests a block <div> inside a <p>. That is invalid HTML and can cause hydration warnings and layout glitches. Every other section on this page keeps the blank line.

Suggested change

Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. The feature also supports group mentions like @all, enabling users to quickly notify all members in a group chat simultaneously.

Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. The feature also supports group mentions like @all, enabling users to quickly notify all members in a group chat simultaneously.

suraj-chauhan-cometchat · 2026-10-16T09:52:59Z

+The Report Message feature allows users to report inappropriate or harmful messages within the chat. Users can choose from predefined reasons and provide additional remarks for detailed context. This feature helps maintain a safe and respectful chat environment.
+
+<Frame>
+  <img src="/images/android-flag-message.png" />


Wrong-platform screenshot. /images/android-flag-message.png is the Android UI Kit screenshot (copied from ui-kit/android/core-features.mdx:143). React Native renders CometChatReportDialog, which looks different. Please swap in an RN capture.

suraj-chauhan-cometchat · 2026-10-16T09:53:00Z

+
+## Report Message
+
+The Report Message feature allows users to report inappropriate or harmful messages within the chat. Users can choose from predefined reasons and provide additional remarks for detailed context. This feature helps maintain a safe and respectful chat environment.


Missing visibility conditions. The Report option only appears on other users' messages: MessageDataSource.tsx:1138 gates it on !isSentByMe. The list also force-hides it for agentic (AI) users. Without a note, developers testing on their own messages will think the feature is missing.

suraj-chauhan-cometchat · 2026-10-16T09:53:01Z

 | **hideAuxiliaryButtons**              | toggle visibility of Auxiliary button option.                                                                                                                                                                                                   | `hideAuxiliaryButtons={true}`                                    |
 | **disableMentions**                   | Sets whether mentions in text should be disabled. Processes the text formatters If there are text formatters available and the disableMentions flag is set to true, it removes any formatters that are instances of CometChatMentionsFormatter. | `disableMentions={true}`                                         |
+| **disableMentionAll**           | Controls whether group mentions like @all appear in suggestions.                        | `disableMentionAll={true}`                        |
+| **mentionAllLabel**             | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.).     | `mentionAllLabel="all"`                           |


Example uses the default value. "all" is already the default (CometChatMessageComposer.tsx:518), so this snippet shows no customization. Use a label like "channel", which also makes clear the label goes in without a leading @.

Suggested change

| **mentionAllLabel** | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `mentionAllLabel="all"` |

| **mentionAllLabel** | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). Defaults to `all`. | `mentionAllLabel="channel"` |

suraj-chauhan-cometchat · 2026-10-16T09:53:02Z

 | **hideSendButton**                    | toggle visibility of send button option.                                                                                                                                                                                                        | `hideSendButton={true}`                                          |
 | **hideAuxiliaryButtons**              | toggle visibility of Auxiliary button option.                                                                                                                                                                                                   | `hideAuxiliaryButtons={true}`                                    |
 | **disableMentions**                   | Sets whether mentions in text should be disabled. Processes the text formatters If there are text formatters available and the disableMentions flag is set to true, it removes any formatters that are instances of CometChatMentionsFormatter. | `disableMentions={true}`                                         |
+| **disableMentionAll**           | Controls whether group mentions like @all appear in suggestions.                        | `disableMentionAll={true}`                        |


Missing caveats. The @ALL suggestion only appears in group conversations: buildGroupMentionItem returns null without a group. It also has no effect when disableMentions={true}. Consider noting both here.

suraj-chauhan-cometchat · 2026-10-16T09:53:03Z

+
+| Components                                      | Functionality                                                                                                                                                                                                              |
+| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Message List](/ui-kit/react-native/message-list) | [Message List](/ui-kit/react-native/message-list) provides the "Report Message" option in the message actions menu, allowing users to initiate the reporting process for inappropriate messages. |


Nit: this table uses 'Message List' (with a space), while every other table on this page uses MessageList. The column padding also doesn't line up with the header.

suraj-chauhan-cometchat · 2026-10-16T09:53:04Z

 | **hideMessageInfoOption**      | used to toggle visibility of hide message info option in MessageList                                                                               | `hideMessageInfoOption={true}`                            |
 | **hideGroupActionMessages**    | used to toggle visibility of hide group action info option in MessageList                                                                          | `hideGroupActionMessages={true}`                          |
 | **hideTimestamp**              | used to toggle visibility of hide timestamp in MessageList                                                                                         | `hideTimestamp={true}`                                    |
+| **hideFlagMessageOption**         | Hides the "Report Message" option from message actions menu.                                  | `hideFlagMessageOption={true}`                 |


Nit: the prop is hideFlag* and the source calls the option "Flag Message", but the docs call it "Report Message". Consider saying "Report (flag) Message" once, so readers searching for either name land here.

suraj-chauhan-cometchat · 2026-10-16T10:01:45Z

Closing: main already has everything this PR adds — the Report Message section, hideFlagMessageOption / hideFlagRemarkField (with the correct names), and disableMentionAll / mentionAllLabel. The review points that still apply to main (own-message and AI-agent visibility for Report, @ALL being group-only, the @ALL sentence under Mentions) are being fixed in #524. Thanks @swayam-cometchat!

…39154 Carries over the review points from the closed #161 that still applied to main, checked against UI Kit 5.5.2 (master-v5): - core-features: Report option shows only on other users' messages (MessageDataSource !isSentByMe) and is hidden for AI agents. - core-features: mention @ALL under Mentions (group chats only). - message-composer: @ALL is group-only, label has no leading @, default "all", no effect with disableMentions. - TODO marker: Report screenshot is the Android one, needs an RN capture. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Enhance documentation for Mentions and add Report Message feature det…

03a12cf

…ails

swayam-cometchat requested a review from jitvarpatil as a code owner December 2, 2025 12:55

swayam-cometchat requested review from honey-cometchat and raj-dubey1 December 2, 2025 12:55

mintlify Bot deployed to staging December 2, 2025 12:58

View deployment

suraj-chauhan-cometchat reviewed Oct 16, 2026

View reviewed changes

suraj-chauhan-cometchat closed this Oct 16, 2026

Navigation Menu

Repository navigation

Enhance documentation for Mentions and add Report Message feature det… - #161

Enhance documentation for Mentions and add Report Message feature det…#161
swayam-cometchat wants to merge 1 commit into
mainfrom
feature/react-native-flag-and-channel

swayam-cometchat commented Dec 2, 2025

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat Oct 16, 2026

Uh oh!

suraj-chauhan-cometchat commented Oct 16, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

	\| hideFlagMessageOption \| Hides the remark text area in the flag message dialog. \| `hideFlagRemarkField={true}` \|
	\| hideFlagRemarkField \| Hides the remark text area in the flag message dialog. \| `hideFlagRemarkField={true}` \|


		Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation.

		Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. The feature also supports group mentions like @all, enabling users to quickly notify all members in a group chat simultaneously.


		## Report Message

		The Report Message feature allows users to report inappropriate or harmful messages within the chat. Users can choose from predefined reasons and provide additional remarks for detailed context. This feature helps maintain a safe and respectful chat environment.

	\| mentionAllLabel \| Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). \| `mentionAllLabel="all"` \|
	\| mentionAllLabel \| Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). Defaults to `all`. \| `mentionAllLabel="channel"` \|

Conversation

swayam-cometchat commented Dec 2, 2025

Description

Related Issue(s)

Type of Change

Checklist

Additional Information

Screenshots (if applicable)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

suraj-chauhan-cometchat commented Oct 16, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants