feat:✨Added support of date-time format for the groupSeparatorBuilder(#…

…93).
SimformSolutionsPvtLtd · Aug 28, 2023 · 340cbb2 · 340cbb2
1 parent 31eedc2
commit 340cbb2
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [1.4.0]
+
+* **Feat**: [93](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues/93)Added support
+  of date-time format for the groupSeparatorBuilder of 'ChatBackgroundConfiguration' class.
+
 ## [1.3.1]
 
 * **Feat**: [105](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/pull/105) Allow user 

diff --git a/example/lib/data.dart b/example/lib/data.dart
@@ -1,20 +1,26 @@
 import 'package:chatview/chatview.dart';
 
 class Data {
+  final currentDate = DateTime.now();
   static const profileImage =
       "https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_showcaseview/master/example/assets/simform.png";
   static final messageList = [
     Message(
       id: '1',
       message: "Hi!",
-      createdAt: DateTime.now(),
-      sendBy: '1', // userId of who sends the message
+      createdAt: DateTime.now().copyWith(
+        day: DateTime.now().day - 2,
+      ),
+      sendBy: '1',
+      // userId of who sends the message
       status: MessageStatus.read,
     ),
     Message(
       id: '2',
       message: "Hi!",
-      createdAt: DateTime.now(),
+      createdAt: DateTime.now().copyWith(
+        day: DateTime.now().day - 1,
+      ),
       sendBy: '2',
       status: MessageStatus.read,
     ),

diff --git a/lib/src/extensions/extensions.dart b/lib/src/extensions/extensions.dart
@@ -31,14 +31,14 @@ import '../utils/package_strings.dart';
 extension TimeDifference on DateTime {
   String get getDay {
     final DateTime formattedDate = DateFormat(dateFormat).parse(toString());
-    final DateFormat formatter = DateFormat.yMMMMd(enUS);
+    final DateFormat formatter = DateFormat(dateFormatWithTime,enUS);
     final differenceInDays = formattedDate.difference(DateTime.now()).inDays;
     if (differenceInDays == 0) {
       return PackageStrings.today;
     } else if (differenceInDays <= 1 && differenceInDays >= -1) {
       return PackageStrings.yesterday;
     } else {
-      return formatter.format(formattedDate);
+      return formatter.format(this);
     }
   }
 

diff --git a/lib/src/models/message_list_configuration.dart b/lib/src/models/message_list_configuration.dart
@@ -44,7 +44,7 @@ class ChatBackgroundConfiguration {
   final double? width;
 
   /// Provides configurations of chat separator widget.
-  final StringWithReturnWidget? groupSeparatorBuilder;
+  final MessageGroupSeparator? groupSeparatorBuilder;
 
   /// Used to define the order of a [GroupedListView] or [SliverGroupedListView].
   final GroupedListOrder groupedListOrder;

diff --git a/lib/src/utils/constants/constants.dart b/lib/src/utils/constants/constants.dart
@@ -32,6 +32,7 @@ const String emojiRegExpression =
 const String imageUrlRegExpression =
     r'(http(s?):)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpeg)';
 const String dateFormat = "yyyy-MM-dd";
+const String dateFormatWithTime = "E, d MMM yyyy HH:mm";
 const String jpg = ".jpg";
 const String png = ".png";
 const String jpeg = ".jpeg";

diff --git a/lib/src/values/typedefs.dart b/lib/src/values/typedefs.dart
@@ -33,5 +33,5 @@ typedef DoubleCallBack = void Function(double, double);
 typedef MessageCallBack = void Function(Message message);
 typedef VoidCallBackWithFuture = Future<void> Function();
 typedef StringsCallBack = void Function(String emoji, String messageId);
-typedef StringWithReturnWidget = Widget Function(String separator);
+typedef MessageGroupSeparator = Widget Function(DateTime separator);
 typedef DragUpdateDetailsCallback = void Function(DragUpdateDetails);
diff --git a/lib/src/widgets/chat_groupedlist_widget.dart b/lib/src/widgets/chat_groupedlist_widget.dart
@@ -274,29 +274,48 @@ class _ChatGroupedListWidgetState extends State<ChatGroupedListWidget>
   }
 
   Widget get _chatStreamBuilder {
+    DateTime? lastMatchedDate;
+
     return StreamBuilder<List<Message>>(
       stream: chatController?.messageStreamController.stream,
       builder: (context, snapshot) {
         return snapshot.connectionState.isActive
-            ? GroupedListView<Message, String>(
+            ? GroupedListView<Message, DateTime>(
                 shrinkWrap: true,
                 elements: snapshot.data!,
-                groupBy: (element) => element.createdAt.getDateFromDateTime,
+                groupBy: (element) {
+                  if (lastMatchedDate == null) {
+                    lastMatchedDate = element.createdAt;
+                    return element.createdAt;
+                  }
+                  /// when conversation is going-on on same date we return
+                  /// same date [lastMatchedDate]
+                  else if (lastMatchedDate!.getDateFromDateTime ==
+                      element.createdAt.getDateFromDateTime) {
+                    return lastMatchedDate!;
+                  }
+                  /// When conversation start at new date
+                  else {
+                    lastMatchedDate = element.createdAt;
+                    return element.createdAt;
+                  }
+                },
                 itemComparator: (message1, message2) =>
                     message1.message.compareTo(message2.message),
                 physics: const NeverScrollableScrollPhysics(),
                 order: chatBackgroundConfig.groupedListOrder,
                 sort: chatBackgroundConfig.sortEnable,
-                groupSeparatorBuilder: (separator) =>
-                    featureActiveConfig?.enableChatSeparator ?? false
-                        ? _GroupSeparatorBuilder(
-                            separator: separator,
-                            defaultGroupSeparatorConfig: chatBackgroundConfig
-                                .defaultGroupSeparatorConfig,
-                            groupSeparatorBuilder:
-                                chatBackgroundConfig.groupSeparatorBuilder,
-                          )
-                        : const SizedBox.shrink(),
+                groupSeparatorBuilder: (separator) {
+                  return featureActiveConfig?.enableChatSeparator ?? false
+                      ? _GroupSeparatorBuilder(
+                          separator: separator,
+                          defaultGroupSeparatorConfig:
+                              chatBackgroundConfig.defaultGroupSeparatorConfig,
+                          groupSeparatorBuilder:
+                              chatBackgroundConfig.groupSeparatorBuilder,
+                        )
+                      : const SizedBox.shrink();
+                },
                 indexedItemBuilder: (context, message, index) {
                   return ValueListenableBuilder<String?>(
                     valueListenable: _replyId,
@@ -350,16 +369,16 @@ class _GroupSeparatorBuilder extends StatelessWidget {
     this.groupSeparatorBuilder,
     this.defaultGroupSeparatorConfig,
   }) : super(key: key);
-  final String separator;
-  final StringWithReturnWidget? groupSeparatorBuilder;
+  final DateTime separator;
+  final MessageGroupSeparator? groupSeparatorBuilder;
   final DefaultGroupSeparatorConfiguration? defaultGroupSeparatorConfig;
 
   @override
   Widget build(BuildContext context) {
     return groupSeparatorBuilder != null
         ? groupSeparatorBuilder!(separator)
         : ChatGroupHeader(
-            day: DateTime.parse(separator),
+            day: separator,
             groupSeparatorConfig: defaultGroupSeparatorConfig,
           );
   }

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: chatview
 description: A Flutter package that allows you to integrate Chat View with highly customization options.
-version: 1.3.1
+version: 1.4.0
 issue_tracker: https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues
 repository: https://github.com/SimformSolutionsPvtLtd/flutter_chatview