refactor(ui, core): Deprecate v3

Signed-off-by: xsahil03x <[email protected]>

packages/stream_chat_flutter/lib/src/user_mentions_overlay.dart

@@ -6,16 +6,22 @@ import 'package:stream_chat_flutter_core/stream_chat_flutter_core.dart';
 
 /// Builder function for building a mention tile.
 ///
-/// Use [UserMentionTile] for the default implementation.
+/// Use [StreamUserMentionTile] for the default implementation.
 typedef MentionTileBuilder = Widget Function(
   BuildContext context,
   User user,
 );
 
+/// {@macro user_mention_tile}
+@Deprecated("Use 'StreamUserMentionsOverlay' instead")
+typedef UserMentionsOverlay = StreamUserMentionsOverlay;
+
+/// {@template user_mentions_overlay}
 /// Overlay for displaying users that can be mentioned.
-class UserMentionsOverlay extends StatefulWidget {
-  /// Constructor for creating a [UserMentionsOverlay].
-  UserMentionsOverlay({
+/// {@endtemplate}
+class StreamUserMentionsOverlay extends StatefulWidget {
+  /// Constructor for creating a [StreamUserMentionsOverlay].
+  StreamUserMentionsOverlay({
     Key? key,
     required this.query,
     required this.channel,
@@ -62,10 +68,11 @@ class UserMentionsOverlay extends StatefulWidget {
   final void Function(User user)? onMentionUserTap;
 
   @override
-  _UserMentionsOverlayState createState() => _UserMentionsOverlayState();
+  _StreamUserMentionsOverlayState createState() =>
+      _StreamUserMentionsOverlayState();
 }
 
-class _UserMentionsOverlayState extends State<UserMentionsOverlay> {
+class _StreamUserMentionsOverlayState extends State<StreamUserMentionsOverlay> {
   late Future<List<User>> userMentionsFuture;
 
   @override
@@ -75,7 +82,7 @@ class _UserMentionsOverlayState extends State<UserMentionsOverlay> {
   }
 
   @override
-  void didUpdateWidget(covariant UserMentionsOverlay oldWidget) {
+  void didUpdateWidget(covariant StreamUserMentionsOverlay oldWidget) {
     super.didUpdateWidget(oldWidget);
     if (widget.channel != oldWidget.channel ||
         widget.query != oldWidget.query ||
@@ -116,7 +123,7 @@ class _UserMentionsOverlayState extends State<UserMentionsOverlay> {
                   child: InkWell(
                     onTap: () => widget.onMentionUserTap?.call(user),
                     child: widget.mentionsTileBuilder?.call(context, user) ??
-                        UserMentionTile(user),
+                        StreamUserMentionTile(user),
                   ),
                 );
               },