docs(flutter): Add custom mentions formatter guide with filtering exa…#326
Merged
swapnil-cometchat merged 1 commit intomainfrom Apr 8, 2026
Merged
Conversation
…mple - Add new custom-mentions-formatter-guide.mdx with complete implementation walkthrough - Document how to extend CometChatMentionsFormatter to filter suggestions and handle tap interactions - Include mermaid flowchart explaining the filtering proxy pattern - Add _FilteredSuggestionSink wrapper class example that removes logged-in user from mentions - Update docs.json to register new guide in Flutter documentation navigation - Update mentions-formatter-guide.mdx with cross-reference to custom formatter guide - Update custom-text-formatter-guide.mdx with related links section - Provide setup instructions, use case explanation, and step-by-step implementation guide - Target v5.2.13 and above with version compatibility warning
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
jitvarpatil
approved these changes
Apr 8, 2026
adityakotasthane07
approved these changes
Apr 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
custom-mentions-formatter-guide.mdxwith complete implementation walkthroughCometChatMentionsFormatterto filter suggestions and handle tap interactions_FilteredSuggestionSinkwrapper class example that removes logged-in user from mentionsdocs.jsonto register new guide in Flutter documentation navigationmentions-formatter-guide.mdxwith cross-reference to custom formatter guidecustom-text-formatter-guide.mdxwith related links sectionDescription
Adds a new documentation page for creating a custom mentions formatter in the CometChat Flutter UI Kit (v5). The guide walks developers through extending
CometChatMentionsFormatterto customize@mentionsuggestion behavior — filtering who appears in the suggestion list, styling mentions, and handling tap interactions. The implementation uses aStreamSinkproxy pattern to intercept and filter suggestions before they reach the UI. All code examples have been verified against the actual UI Kit source (cometchat_chat_uikitv5.2.13). Cross-links have been added to the existing mentions formatter and custom text formatter pages.Related Issue(s)
N/A
Type of Change
Checklist
Additional Information
cometchat_chat_uikitsource (v5.2.13)mentionSelfTextColor,mentionTextColor, etc.) matchCometChatMentionsStyleexactlySuggestionListItemfields (id,title,data, etc.) verified against sourcetextFormatters,disableMentions,parentMessageId) confirmed in bothCometChatMessageComposerandCometChatCompactMessageComposermaster_app/lib/utils/custom_mentions_formatter.dart