Feat(ui): simplify messagelist constructor (#2674)

* Simplify mesagelist constructor

* rename listview config and builders

* use themeGen on messagelistview theme

* Fixed leftover doc issues

* improve switch and if statements

Author: renefloor

packages/stream_chat_flutter/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 🛑️ Breaking
 
+- `StreamMessageListView` had its large set of configuration and builder parameters reorganized. Behavior flags (e.g. `swipeToReply`, `markReadWhenAtTheBottom`, `showScrollToBottom`, `reverse`, `paginationLimit`, `scrollPhysics`, etc.) moved to `StreamMessageListViewConfiguration`, passed directly as `StreamMessageListView.config`. Custom builder callbacks (`headerBuilder`, `footerBuilder`, `loadingBuilder`, `emptyBuilder`, `errorBuilder`, `messageListBuilder`, `parentMessageBuilder`, `dateDividerBuilder`, `floatingDateDividerBuilder`, `threadSeparatorBuilder`, `unreadMessagesSeparatorBuilder`, `scrollToBottomBuilder`, `paginationLoadingIndicatorBuilder`, `spacingWidgetBuilder`, `systemMessageBuilder`, `ephemeralMessageBuilder`, `moderatedMessageBuilder`) moved to `StreamMessageListViewBuilders`, passed directly as `StreamMessageListView.builders`. The `messageBuilder` parameter is back at the root of the constructor as before.
 - Bumped `file_picker` to `^11.0.0` to resolve [#2599](https://github.com/GetStream/stream-chat-flutter/issues/2599). Apps depending on `file_picker` directly must also upgrade past `11.0.0`, which replaces the instance-based `FilePicker.platform.*` API with static `FilePicker.*` methods.
 - Renamed `StreamMessageComposer.messageInputController` parameter to `messageComposerController`.
 - Removed `StreamDraftListView`, `StreamDraftListTile`, `StreamDraftListTileTheme`, and `StreamDraftListTileThemeData` from the SDK. Also removed `StreamChatThemeData.draftListTileTheme`. Refer to the sample app for a reference implementation using `StreamDraftListController` and `PagedValueListView`.

packages/stream_chat_flutter/example/lib/main.dart

@@ -263,9 +263,9 @@ class _ChannelPageState extends State<ChannelPage> {
         children: <Widget>[
           Expanded(
             child: StreamMessageListView(
+              config: const StreamMessageListViewConfiguration(swipeToReply: true),
               threadBuilder: (_, parent) => ThreadPage(parent: parent!),
               onReplyTap: reply,
-              swipeToReply: true,
             ),
           ),
           StreamMessageComposer(

packages/stream_chat_flutter/example/lib/tutorial_part_5.dart

@@ -7,11 +7,12 @@ import 'package:stream_chat_flutter/stream_chat_flutter.dart';
 /// Customizing how messages are rendered is another very common use-case that
 /// the SDK supports easily.
 ///
-/// Replacing the built-in message component with your own is done by passing
-/// it as a builder function to the [StreamMessageListView] widget.
+/// Replacing the built-in message component with your own is done by
+/// passing a `messageBuilder` to [StreamMessageListView].
 ///
-/// The message builder function will get the usual [BuildContext] argument
-/// as well as the [Message] object and its position inside the list.
+/// The builder receives the [BuildContext], the [Message], and the
+/// pre-configured [StreamMessageItemProps] with all list-level callbacks
+/// already wired in.
 ///
 /// If you look at the code you can see that we use [StreamChat.of] to
 /// retrieve the current user so that we can style messages in a different way.
@@ -117,7 +118,7 @@ class ChannelPage extends StatelessWidget {
         children: <Widget>[
           Expanded(
             child: StreamMessageListView(
-              messageBuilder: _messageBuilder,
+              messageBuilder: _messageItemBuilder,
             ),
           ),
           StreamMessageComposer(),
@@ -126,10 +127,10 @@ class ChannelPage extends StatelessWidget {
     );
   }
 
-  Widget _messageBuilder(
+  Widget _messageItemBuilder(
     BuildContext context,
     Message message,
-    StreamMessageItemProps defaultProps,
+    StreamMessageItemProps props,
   ) {
     final isCurrentUser = StreamChat.of(context).currentUser!.id == message.user!.id;
     final textAlign = isCurrentUser ? TextAlign.right : TextAlign.left;
@@ -139,22 +140,12 @@ class ChannelPage extends StatelessWidget {
       padding: const EdgeInsets.all(5),
       child: DecoratedBox(
         decoration: BoxDecoration(
-          border: Border.all(
-            color: color,
-          ),
-          borderRadius: const BorderRadius.all(
-            Radius.circular(5),
-          ),
+          border: Border.all(color: color),
+          borderRadius: const BorderRadius.all(Radius.circular(5)),
         ),
         child: ListTile(
-          title: Text(
-            message.text!,
-            textAlign: textAlign,
-          ),
-          subtitle: Text(
-            message.user!.name,
-            textAlign: textAlign,
-          ),
+          title: Text(message.text!, textAlign: textAlign),
+          subtitle: Text(message.user!.name, textAlign: textAlign),
         ),
       ),
     );

packages/stream_chat_flutter/lib/src/components/stream_chat_component_builders.dart

@@ -3,8 +3,11 @@ import 'package:stream_chat_flutter/stream_chat_flutter.dart';
 
 /// Builds the list of component builders for the stream chat components.
 Iterable<StreamComponentBuilderExtension<Object>> streamChatComponentBuilders({
+  // ── Channel / thread list ────────────────────────────────────────────────
   StreamComponentBuilder<StreamChannelListItemProps>? channelListItem,
   StreamComponentBuilder<StreamThreadListTileProps>? threadListItem,
+
+  // ── Message composer ─────────────────────────────────────────────────────
   StreamComponentBuilder<MessageComposerProps>? messageComposer,
   StreamComponentBuilder<MessageComposerLeadingProps>? messageComposerLeading,
   StreamComponentBuilder<MessageComposerTrailingProps>? messageComposerTrailing,
@@ -16,6 +19,8 @@ Iterable<StreamComponentBuilderExtension<Object>> streamChatComponentBuilders({
   StreamComponentBuilder<StreamMessageItemProps>? messageItem,
   StreamComponentBuilder<StreamMessageComposerAttachmentListProps>? messageComposerAttachmentList,
   StreamComponentBuilder<StreamMessageComposerAttachmentProps>? messageComposerAttachment,
+
+  // ── Attachments ──────────────────────────────────────────────────────────
   StreamComponentBuilder<StreamImageAttachmentProps>? imageAttachment,
   StreamComponentBuilder<StreamVideoAttachmentProps>? videoAttachment,
   StreamComponentBuilder<StreamGiphyAttachmentProps>? giphyAttachment,