docs(flutter): Add image preview and caption guide for UI Kit#329
Merged
swapnil-cometchat merged 1 commit intomainfrom Apr 9, 2026
Merged
Conversation
- Add new guide document for image preview and caption functionality - Include inline image preview widget above composer during image selection - Document caption display below image thumbnails in message bubbles - Add component specifications and architecture diagrams - Include integration steps with code examples for custom attachment options - Update docs.json to register new guide in Flutter UI Kit navigation
anshuman-cometchat
requested review from
adityakotasthane07 and
rishikesh-devare-cometchat
adityakotasthane07
approved these changes
Apr 9, 2026
jitvarpatil
approved these changes
Apr 9, 2026
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Add Image Preview & Caption Guide for Flutter UI Kit
Description
Adds a new guide document (
ui-kit/flutter/guide-image-caption.mdx) for the Image Preview & Caption feature in the CometChat Flutter UI Kit. The guide covers:headerViewwhen a user picks an image from gallery or cameraCometChatMessageTemplateattachmentOptions,headerView,stateCallBack,onSendButtonTap, andtemplatesheaderViewvsshowPanel,templatesvsaddTemplate, and iOS path encodingdocs.jsonupdated to registerui-kit/flutter/guide-image-captionin the Flutter UI Kit Guides navigation groupNo UIKit source files are modified — the guide uses only public extension points.
Related Issue(s)
N/A
Type of Change
Checklist
Additional Information
The guide documents a working implementation in
chat-uikit-flutter/master_app/lib/messages/. The two implementation files are:messages.dart— state management, composer configuration, send interception, custom image templateimage_preview_screen.dart—InlineImagePreviewwidgetThe approach avoids modifying any UIKit source code by leveraging five composer/message-list extension points. The guide includes a gotchas table documenting non-obvious behaviors discovered during implementation (zero-width space for send button enablement, caption extraction timing, mentions formatter panel conflicts, template merge semantics, iOS path encoding).
Screenshots (if applicable)
N/A — the guide contains an ASCII architecture diagram and component specification table. Actual UI screenshots should be captured from a running device and added before merge.