feat: 🤖 Introduced animated typewriter functionality, allowing developers to seamlessly integrate the chat view for chatbot implementations.

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.5.0]
+
+* **Feat**: [309](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues/309) Introduced animated typewriter functionality, allowing developers to seamlessly integrate the chat view for chatbot implementations.
+
 ## [2.4.0]
 
 * **Feat**: [251](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/issues/251) Add

example/lib/main.dart

@@ -65,6 +65,11 @@ class _ChatScreenState extends State<ChatScreen> {
         profilePhoto: Data.profileImage,
       ),
     ],
+
+    ///Uncomment to enable typewriter functionality
+    // typewriterAnimatedConfiguration: TypewriterAnimatedConfiguration(
+    //   enableConfiguration: true,
+    // ),
   );
 
   void _showHideTypingIndicator() {

lib/chatview.dart

@@ -38,3 +38,4 @@ export 'package:audio_waveforms/audio_waveforms.dart'
 export 'src/models/config_models/receipts_widget_config.dart';
 export 'src/extensions/extensions.dart' show MessageTypes;
 export 'package:emoji_picker_flutter/emoji_picker_flutter.dart';
+export '/src/models/config_models/typing_configuration.dart';

lib/src/controller/chat_controller.dart

@@ -21,6 +21,7 @@
  */
 import 'dart:async';
 
+import 'package:chatview/src/models/config_models/typing_configuration.dart';
 import 'package:chatview/src/widgets/suggestions/suggestion_list.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
@@ -74,12 +75,27 @@ class ChatController {
   /// Provides current user which is sending messages.
   final ChatUser currentUser;
 
+  ///Configuration for Animated Typewriter functionality as in a chatbot.
+  TypewriterAnimatedConfiguration typewriterAnimatedConfiguration;
+
+  ///Gives us control of the TextEditting controller of the TextField of the current user
+  TextEditingController textEdittingController;
+
+  ///Enable adding more function to what already exits on the [onChange] callback of the [TextField]
+  VoidCallback? onChangedFunct;
+
   ChatController({
     required this.initialMessageList,
     required this.scrollController,
     required this.otherUsers,
     required this.currentUser,
-  });
+    this.onChangedFunct,
+    TextEditingController? textEdittingController,
+    TypewriterAnimatedConfiguration? typewriterAnimatedConfiguration,
+  })  : typewriterAnimatedConfiguration = typewriterAnimatedConfiguration ??
+            TypewriterAnimatedConfiguration(),
+        textEdittingController =
+            textEdittingController ?? TextEditingController();
 
   /// Represents message stream of chat
   StreamController<List<Message>> messageStreamController = StreamController();

lib/src/models/config_models/send_message_configuration.dart

@@ -32,9 +32,12 @@ class SendMessageConfiguration {
   /// Used to give background color to text field.
   final Color? textFieldBackgroundColor;
 
-  /// Used to give color to send button.
+  /// Used to give color to send button icon.
   final Color? defaultSendButtonColor;
 
+  /// Used to give color to send button background.
+  final Color? defaultSendButtonBackgroundColor;
+
   /// Provides ability to give custom send button.
   final Widget? sendButtonIcon;
 
@@ -59,6 +62,9 @@ class SendMessageConfiguration {
   /// Provides configuration of text field.
   final TextFieldConfiguration? textFieldConfig;
 
+  ///For adding other actions component to the textfield
+  final List<Widget> actionsWidget;
+
   /// Enable/disable voice recording. Enabled by default.
   final bool allowRecordingVoice;
 
@@ -94,6 +100,8 @@ class SendMessageConfiguration {
     this.voiceRecordingConfiguration,
     this.micIconColor,
     this.cancelRecordConfiguration,
+    this.defaultSendButtonBackgroundColor,
+    this.actionsWidget = const [],
   });
 }
 

lib/src/models/config_models/typing_configuration.dart

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2022 Simform Solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import 'package:animated_text_kit/animated_text_kit.dart';
+
+///Configuration for Animated Typewriter functionality as in a chatbot.
+class TypewriterAnimatedConfiguration {
+  ///Toggle to enable
+  /// By default it is set to false.
+  final bool enableConfiguration;
+
+  /// A controller for managing the state of an animated text sequence.
+  ///
+  /// This controller exposes methods to play, pause, and reset the animation.
+  /// The [AnimatedTextState] enum represents the various states the animation
+  /// can be in. By calling [play()], [pause()], or [reset()], you can transition
+  /// between these states and the animated widget will react accordingly.
+  AnimatedTextController? controller;
+
+  /// Should the animation ends up early and display full text if you tap on it?
+  ///
+  /// By default it is set to false.
+  final bool displayFullTextOnTap;
+
+  ///The [Duration] of the delay between the apparition of each characters
+
+  ///By default it is set to 50 milliseconds.
+  final Duration duration;
+
+  TypewriterAnimatedConfiguration({
+    this.displayFullTextOnTap = false,
+    this.controller,
+    this.enableConfiguration = false,
+    this.duration = const Duration(milliseconds: 50),
+  });
+}