fix: improve documentation and add example

Author: demchenkoalex

packages/cross_cache/example/README.md

@@ -0,0 +1,42 @@
+```dart
+import 'package:flutter/material.dart';
+import 'package:cross_cache/cross_cache.dart';
+
+class MyWidget extends StatefulWidget {
+  @override
+  _MyWidgetState createState() => _MyWidgetState();
+}
+
+class _MyWidgetState extends State<MyWidget> {
+  final _cache = CrossCache(); // Create an instance
+
+  @override
+  void dispose() {
+    _cache.dispose(); // Dispose the cache
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Image(
+      image: CachedNetworkImage(
+        'https://example.com/image.jpg',
+        _cache, // Pass the cache instance
+        headers: {'Authorization': 'Bearer YOUR_TOKEN'}, // Optional headers
+      ),
+      loadingBuilder: (context, child, loadingProgress) {
+        if (loadingProgress == null) return child;
+        return Center(
+          child: CircularProgressIndicator(
+            value: loadingProgress.expectedTotalBytes != null
+                ? loadingProgress.cumulativeBytesLoaded / loadingProgress.expectedTotalBytes!
+                : null,
+          ),
+        );
+      },
+      errorBuilder: (context, error, stackTrace) => Icon(Icons.error),
+    );
+  }
+}
+
+```

packages/cross_cache/lib/cross_cache.dart

@@ -1,2 +1,5 @@
+/// Cross Cache package. Provides a cache for images and files.
+library;
+
 export 'src/cached_network_image.dart';
 export 'src/cross_cache.dart';

packages/flutter_chat_core/example/README.md

@@ -0,0 +1,49 @@
+```dart
+import 'dart:math';
+
+import 'package:flutter/material.dart';
+import 'package:flutter_chat_core/flutter_chat_core.dart';
+import 'package:flutter_chat_ui/flutter_chat_ui.dart';
+
+class Basic extends StatefulWidget {
+  const Basic({super.key});
+
+  @override
+  BasicState createState() => BasicState();
+}
+
+class BasicState extends State<Basic> {
+  final _chatController = InMemoryChatController();
+
+  @override
+  void dispose() {
+    _chatController.dispose();
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      body: Chat(
+        chatController: _chatController,
+        currentUserId: 'user1',
+        onMessageSend: (text) {
+          _chatController.insert(
+            TextMessage(
+              // Better to use UUID or similar for the ID - IDs must be unique
+              id: '${Random().nextInt(1000) + 1}',
+              authorId: 'user1',
+              createdAt: DateTime.now().toUtc(),
+              text: text,
+            ),
+          );
+        },
+        resolveUser: (UserID id) async {
+          return User(id: id, name: 'John Doe');
+        },
+      ),
+    );
+  }
+}
+
+```

packages/flutter_chat_core/lib/flutter_chat_core.dart

@@ -1,3 +1,6 @@
+/// Flutter Chat Core package. Provides the core functionality for the flutter_chat_ui package.
+library;
+
 export 'src/chat_controller/chat_controller.dart';
 export 'src/chat_controller/chat_operation.dart';
 export 'src/chat_controller/in_memory_chat_controller.dart';

packages/flutter_chat_ui/example/README.md

@@ -0,0 +1,49 @@
+```dart
+import 'dart:math';
+
+import 'package:flutter/material.dart';
+import 'package:flutter_chat_core/flutter_chat_core.dart';
+import 'package:flutter_chat_ui/flutter_chat_ui.dart';
+
+class Basic extends StatefulWidget {
+  const Basic({super.key});
+
+  @override
+  BasicState createState() => BasicState();
+}
+
+class BasicState extends State<Basic> {
+  final _chatController = InMemoryChatController();
+
+  @override
+  void dispose() {
+    _chatController.dispose();
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      body: Chat(
+        chatController: _chatController,
+        currentUserId: 'user1',
+        onMessageSend: (text) {
+          _chatController.insert(
+            TextMessage(
+              // Better to use UUID or similar for the ID - IDs must be unique
+              id: '${Random().nextInt(1000) + 1}',
+              authorId: 'user1',
+              createdAt: DateTime.now().toUtc(),
+              text: text,
+            ),
+          );
+        },
+        resolveUser: (UserID id) async {
+          return User(id: id, name: 'John Doe');
+        },
+      ),
+    );
+  }
+}
+
+```

packages/flutter_chat_ui/lib/flutter_chat_ui.dart

@@ -1,3 +1,6 @@
+/// Flutter Chat UI package. Provides the UI for the Flyer Chat.
+library;
+
 export 'src/avatar.dart';
 export 'src/chat.dart';
 export 'src/chat_animated_list/chat_animated_list.dart';

packages/flutter_chat_ui/lib/src/chat_animated_list/chat_animated_list.dart

@@ -144,11 +144,12 @@ class ChatAnimatedList extends StatefulWidget {
   });
 
   @override
-  ChatAnimatedListState createState() => ChatAnimatedListState();
+  // ignore: library_private_types_in_public_api
+  _ChatAnimatedListState createState() => _ChatAnimatedListState();
 }
 
 /// State for [ChatAnimatedList].
-class ChatAnimatedListState extends State<ChatAnimatedList>
+class _ChatAnimatedListState extends State<ChatAnimatedList>
     with TickerProviderStateMixin, WidgetsBindingObserver, KeyboardMixin {
   final GlobalKey<SliverAnimatedListState> _listKey = GlobalKey();
   late final ChatController _chatController;

packages/flutter_chat_ui/lib/src/chat_animated_list/chat_animated_list_reversed.dart

@@ -111,12 +111,13 @@ class ChatAnimatedListReversed extends StatefulWidget {
   });
 
   @override
-  ChatAnimatedListReversedState createState() =>
-      ChatAnimatedListReversedState();
+  // ignore: library_private_types_in_public_api
+  _ChatAnimatedListReversedState createState() =>
+      _ChatAnimatedListReversedState();
 }
 
 /// State for [ChatAnimatedListReversed].
-class ChatAnimatedListReversedState extends State<ChatAnimatedListReversed>
+class _ChatAnimatedListReversedState extends State<ChatAnimatedListReversed>
     with SingleTickerProviderStateMixin {
   final GlobalKey<SliverAnimatedListState> _listKey = GlobalKey();
   late final ChatController _chatController;

packages/flutter_chat_ui/lib/src/chat_message/chat_message_internal.dart

@@ -40,11 +40,11 @@ class ChatMessageInternal extends StatefulWidget {
   });
 
   @override
-  State<ChatMessageInternal> createState() => ChatMessageInternalState();
+  State<ChatMessageInternal> createState() => _ChatMessageInternalState();
 }
 
 /// State for [ChatMessageInternal].
-class ChatMessageInternalState extends State<ChatMessageInternal> {
+class _ChatMessageInternalState extends State<ChatMessageInternal> {
   late StreamSubscription<ChatOperation>? _operationsSubscription;
   late Message _updatedMessage;
 

packages/flutter_chat_ui/lib/src/composer.dart

@@ -13,14 +13,22 @@ class Composer extends StatefulWidget {
   /// Optional controller for the text input field.
   final TextEditingController? textEditingController;
 
-  /// Optional positioning properties.
+  /// Optional left position.
   final double? left;
+
+  /// Optional right position.
   final double? right;
+
+  /// Optional top position.
   final double? top;
+
+  /// Optional bottom position.
   final double? bottom;
 
-  /// Optional blur values for the background (if using glassmorphism).
+  /// Optional X blur value for the background (if using glassmorphism).
   final double? sigmaX;
+
+  /// Optional Y blur value for the background (if using glassmorphism).
   final double? sigmaY;
 
   /// Padding around the composer content.