fix: 🐛 ensure images are properly added to preview when sending messages with text by japanshah-simform · Pull Request #430 · SimformSolutionsPvtLtd/chatview

japanshah-simform · 2026-01-30T08:58:47Z

Description

Before:

Screen.Recording.2026-01-30.at.2.44.17.PM.mov

After:

Simulator.Screen.Recording.-.iPhone.16.Pro.-.2026-05-15.at.12.mp4

Checklist

The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
I have followed the Contributor Guide when preparing my PR.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
I have updated/added relevant examples in examples or docs.

Breaking Change?

Yes, this PR is a breaking change.
No, this PR is not a breaking change.

Related Issues

Copilot

Pull request overview

Fixes image-preview behavior when shouldSendImageWithText is enabled by providing a public API to programmatically add selected images into the SendMessageWidget preview (useful for custom trailing actions).

Changes:

Refactors SendMessageWidget image-selection logic into handleImageSelection.
Adds ChatView.handleImageSelection(context, imagePath) for external/custom action buttons to add images to the preview.
Updates the example and docs to demonstrate the new workflow and enables shouldSendImageWithText in the sample.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
lib/src/widgets/send_message_widget.dart	Extracts image-selection/preview logic into `handleImageSelection` and routes `onImageSelected` through it.
lib/src/widgets/chat_view.dart	Adds a static helper to forward image selection into the SendMessageWidget state.
example/lib/main.dart	Demonstrates adding an image to the preview via `ChatView.handleImageSelection`.
doc/documentation.md	Updates guidance for sending images with text and using the new API (currently contains invalid snippet).
CHANGELOG.md	Adds an unreleased changelog entry for the new fix/API.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-30T09:25:46Z

+  ChatView.handleImageSelection to use shouldSendImageWithText
+  parameter with custom trailing actions.


Changelog entry wording is a bit unclear/grammatically awkward (“Added … to use … parameter …”). Consider rephrasing to something like: “Added ChatView.handleImageSelection to support shouldSendImageWithText when using custom trailingActions.”

Suggested change

ChatView.handleImageSelection to use shouldSendImageWithText

parameter with custom trailing actions.

`ChatView.handleImageSelection` to support `shouldSendImageWithText`

when using custom `trailingActions`.

Copilot · 2026-01-30T09:25:46Z

                                onImageSelected: (images, messageId) {
-                                  if (widget.sendMessageConfig
-                                      .shouldSendImageWithText) {
-                                    if (images.isNotEmpty) {
-                                      _selectedImageViewWidgetKey.currentState
-                                          ?.selectedImages.value = [
-                                        ...?_selectedImageViewWidgetKey
-                                            .currentState?.selectedImages.value,
-                                        images
-                                      ];
-
-                                      FocusScope.of(context)
-                                          .requestFocus(_focusNode);
-                                    }
-                                  } else {
-                                    _onImageSelected(images, '');
-                                  }
+                                  handleImageSelection(images);
                                },


The onImageSelected callback parameter messageId is unused, which triggers the unused_parameter analyzer warning unless it’s named _. Consider changing the callback signature to (imagePath, _) (and renaming images to imagePath for clarity) before calling handleImageSelection(imagePath).

Copilot · 2026-01-30T09:25:46Z

+  void handleImageSelection(String images) {
+    if (widget.sendMessageConfig.shouldSendImageWithText) {
+      if (images.isNotEmpty) {
+        _selectedImageViewWidgetKey.currentState?.selectedImages.value = [
+          ...?_selectedImageViewWidgetKey.currentState?.selectedImages.value,
+          images
+        ];
+        FocusScope.of(context).requestFocus(_focusNode);
+      }
+    } else {
+      _onImageSelected(images, '');


handleImageSelection takes a single image path, but the parameter is named images, which is misleading given the surrounding code uses a list of selected images. Renaming the parameter to imagePath (and updating internal references) would reduce confusion.

Suggested change

void handleImageSelection(String images) {

if (widget.sendMessageConfig.shouldSendImageWithText) {

if (images.isNotEmpty) {

_selectedImageViewWidgetKey.currentState?.selectedImages.value = [

...?_selectedImageViewWidgetKey.currentState?.selectedImages.value,

images

];

FocusScope.of(context).requestFocus(_focusNode);

}

} else {

_onImageSelected(images, '');

void handleImageSelection(String imagePath) {

if (widget.sendMessageConfig.shouldSendImageWithText) {

if (imagePath.isNotEmpty) {

_selectedImageViewWidgetKey.currentState?.selectedImages.value = [

...?_selectedImageViewWidgetKey.currentState?.selectedImages.value,

imagePath

];

FocusScope.of(context).requestFocus(_focusNode);

}

} else {

_onImageSelected(imagePath, '');

Copilot · 2026-01-30T09:25:47Z

+  trailingActions: (context, controller) => [
+    GalleryActionButton(
+    icon: Icon(
+      Icons.photo_rounded,
+      size: 30,
+      color: _theme.iconColor,
+    ),
+    onPressed: (path, replyMessage) {
+      ChatView.handleImageSelection(context, path!);
+    },


The documentation example is using trailingActions directly on SendMessageConfiguration, but that property is on TextFieldConfiguration (sendMessageConfig.textFieldConfig.trailingActions). As written, the snippet won’t compile and may mislead users.

Suggested change

trailingActions: (context, controller) => [

GalleryActionButton(

icon: Icon(

Icons.photo_rounded,

size: 30,

color: _theme.iconColor,

),

onPressed: (path, replyMessage) {

ChatView.handleImageSelection(context, path!);

},

textFieldConfig: TextFieldConfiguration(

trailingActions: (context, controller) => [

GalleryActionButton(

icon: Icon(

Icons.photo_rounded,

size: 30,

color: _theme.iconColor,

),

onPressed: (path, replyMessage) {

ChatView.handleImageSelection(context, path!);

},

),

],

Copilot · 2026-01-30T09:25:47Z

+    icon: Icon(
+      Icons.photo_rounded,
+      size: 30,
+      color: _theme.iconColor,
+    ),
+    onPressed: (path, replyMessage) {
+      ChatView.handleImageSelection(context, path!);
+    },
+  ),


The GalleryActionButton snippet in this code block has mismatched indentation/parentheses and is missing the closing ] / ) needed to end trailingActions and SendMessageConfiguration, so the example won’t compile as-is. Please fix the bracket/parenthesis structure so the snippet is valid Dart.

Suggested change

icon: Icon(

Icons.photo_rounded,

size: 30,

color: _theme.iconColor,

),

onPressed: (path, replyMessage) {

ChatView.handleImageSelection(context, path!);

},

),

icon: Icon(

Icons.photo_rounded,

size: 30,

color: _theme.iconColor,

),

onPressed: (path, replyMessage) {

ChatView.handleImageSelection(context, path!);

},

),

],

Copilot · 2026-01-30T09:25:47Z

+      color: _theme.iconColor,
+    ),
+    onPressed: (path, replyMessage) {
+      ChatView.handleImageSelection(context, path!);


The example calls ChatView.handleImageSelection(context, path!) without guarding for path == null (e.g., user cancels picker). Since path is nullable in the action callbacks, the docs should show a null/empty check (as in the example app) to avoid runtime exceptions.

Suggested change

ChatView.handleImageSelection(context, path!);

if (path != null && path.isNotEmpty) {

ChatView.handleImageSelection(context, path);

}

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

+                                onImageSelected: (imagePath, _) {
+                                  _onImageSelected(imagePath, '');


+///
+/// Displays the selected image full-screen with:
+/// - A close button at the top-left
+/// - An chat name in the top bar


+                          onSend: (imagePath, caption, reply) {
+                            _chatController.addMessage(
+                              Message(
+                                id: '${DateTime.now().microsecondsSinceEpoch}_img',


+                            if (caption.isNotEmpty) {
+                              _chatController.addMessage(
+                                Message(
+                                  id: '${DateTime.now().microsecondsSinceEpoch}_cap',


+  `shouldSendImageWithText` parameter. Images are now sent through an image preview screen in example that
+  supports optional text captions. Use `GalleryActionButton` with a custom preview handler to
+  achieve similar functionality.


+You can customize the view for sending images by using the `GalleryActionButton` in `trailingActions`. Here's a practical example that opens an image preview screen before sending:



vasu-nageshri · 2026-05-15T11:32:37Z

+          children: [
+            Positioned.fill(
+              child: InteractiveViewer(
+                minScale: 0.8,


Is there any specific requirement for keeping minScale at 0.8 here? Allowing the image to shrink below its initial size may not be necessary for the preview screen.

vasu-nageshri · 2026-05-15T11:32:39Z

+                maxScale: 4.0,
+                child: Center(
+                  child: Image.file(
+                    File(widget.imagePath),


Image.file(File(...)) crashes on Flutter Web because dart:io is unsupported. Please take care of web compatibility here as well.

vasu-nageshri · 2026-05-15T11:32:49Z

  }

-  void _onImageSelected(String imagePath, String error) {
+  void _onImageSelected(String imagePath, String messageId) {


messageId is added as a parameter but is never used inside the method body. Please remove the unnecessary parameter if it is not needed.

vasu-nageshri · 2026-05-15T11:34:43Z

+                          chatName: widget.chat.name,
+                          onSend: (imagePath, caption, reply) {
+                            var timeStamp =
+                                DateTime.now().microsecondsSinceEpoch;


timeStamp is never reassigned after initialisation, so final would be more appropriate here than var.

vasu-nageshri · 2026-05-15T11:36:15Z


-## Send Image With Message
-You can send images along with your messages by enabling the `shouldSendImageWithText` flag in `sendMessageConfig` all the other things will be handled by the package itself. Here's how to do it:
+## Send Images


The section title Send Images feels a bit too generic now. Since this flow also includes a preview screen and optional caption handling, a more descriptive title may improve clarity in the documentation.

vasu-nageshri · 2026-05-15T11:39:00Z

+                chatName: widget.chat.name,
+                onSend: (imagePath, caption, reply) {
+                  // Create a timestamp for unique message IDs
+                  var timeStamp = DateTime.now().microsecondsSinceEpoch;


…ges with text

japanshah-simform requested review from dhyash-simform and vatsaltanna-simformsolutions January 30, 2026 08:58

japanshah-simform force-pushed the fix/handle-image-selection branch from 7b71d96 to d6674e8 Compare January 30, 2026 09:01

japanshah-simform self-assigned this Jan 30, 2026

japanshah-simform force-pushed the fix/handle-image-selection branch from d6674e8 to 761c6c3 Compare January 30, 2026 09:04

japanshah-simform changed the title ~~Handle Image Selection~~ fix: 🐛 ensure images are properly added to preview when sending messages with text Jan 30, 2026

dhyash-simform requested a review from Copilot January 30, 2026 09:21

Copilot started reviewing on behalf of dhyash-simform January 30, 2026 09:21 View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

japanshah-simform force-pushed the fix/handle-image-selection branch 5 times, most recently from 53c6032 to b6566fc Compare May 15, 2026 07:48

japanshah-simform requested a review from Copilot May 15, 2026 07:48

Copilot started reviewing on behalf of japanshah-simform May 15, 2026 07:48 View session

Copilot stopped reviewing on behalf of japanshah-simform due to an error May 15, 2026 08:11
Workflow completed but conclusion is not available. This may indicate rate limiting or API issues.

Copilot AI reviewed May 15, 2026

View reviewed changes

japanshah-simform force-pushed the fix/handle-image-selection branch from b6566fc to f5c40d8 Compare May 15, 2026 09:17

vasu-nageshri reviewed May 15, 2026

View reviewed changes

vasu-nageshri requested changes May 15, 2026

View reviewed changes

fix: 🐛 ensure images are properly added to preview when sending messa…

307d0a7

…ges with text

japanshah-simform force-pushed the fix/handle-image-selection branch from f5c40d8 to 307d0a7 Compare May 15, 2026 12:25

		ChatView.handleImageSelection to use shouldSendImageWithText
		parameter with custom trailing actions.

-      ChatView.handleImageSelection(context, path!);
+      if (path != null && path.isNotEmpty) {
+        ChatView.handleImageSelection(context, path);
+      }

		onImageSelected: (imagePath, _) {
		_onImageSelected(imagePath, '');

		You can customize the view for sending images by using the `GalleryActionButton` in `trailingActions`. Here's a practical example that opens an image preview screen before sending:

Conversation

japanshah-simform commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Breaking Change?

Related Issues

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

vasu-nageshri May 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

japanshah-simform commented Jan 30, 2026 •

edited

Loading