Skip to content

Commit c624230

Browse files
committed
chore: add more docs
1 parent d3fd4b6 commit c624230

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

packages/stream_chat_flutter/lib/src/message_list_view/floating_date_divider.dart

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,24 @@ class FloatingDateDivider extends StatelessWidget {
2525
@Deprecated('No longer used, Will be removed in future versions.')
2626
final bool isThreadConversation;
2727

28-
// ignore: public_member_api_docs
28+
/// A [ValueListenable] that provides the positions of items in the list view.
2929
final ValueListenable<Iterable<ItemPosition>> itemPositionListener;
3030

31-
// ignore: public_member_api_docs
31+
/// Whether the list is reversed or not.
3232
final bool reverse;
3333

34-
// ignore: public_member_api_docs
34+
/// The list of messages which are displayed in the list view.
3535
final List<Message> messages;
3636

37-
// ignore: public_member_api_docs
37+
/// The total number of items in the list view, including special items like
38+
/// loaders, headers, and footers.
3839
final int itemCount;
3940

40-
// ignore: public_member_api_docs
41+
/// A optional builder function that creates a widget to display the date
42+
/// divider.
43+
///
44+
/// If provided, this function will be called with the date of the message
45+
/// to create the date divider widget.
4146
final Widget Function(DateTime)? dateDividerBuilder;
4247

4348
@override

0 commit comments

Comments
 (0)