chatbot_support_kit 1.0.1
chatbot_support_kit: ^1.0.1 copied to clipboard
A customizable floating chatbot widget for Flutter apps. Drop-in chat UI with AI integration, WebSocket support, and beautiful animations.
Chatbot Support Kit #
A customizable floating chatbot widget for Flutter apps. Similar to web chat widgets, this package adds a floating chat button to your app that opens a beautiful chat interface with AI integration support.
β¨ Features #
- π― Drop-in Widget - Wrap any widget to add chat functionality
- π¬ Beautiful Chat UI - Modern chat interface with smooth animations
- π¨ Fully Customizable - Colors, sizes, messages, and positioning
- π€ AI Integration - Built-in support for AI-powered responses
- π WebSocket Support - Real-time communication via WebSocket
- β¨οΈ Typing Indicator - Animated typing indicator for bot responses
- π± Responsive - Works on all screen sizes
πΈ Preview #
π Installation #
Add this to your pubspec.yaml:
dependencies:
chatbot_support_kit: ^1.0.0
Then run:
flutter pub get
π Usage #
Basic Usage #
Wrap your app content with ChatBotWidget:
import 'package:chatbot_support_kit/chatbot_support_kit.dart';
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'ChatBot Widget Demo',
debugShowCheckedModeBanner: false,
theme: ThemeData(
colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
useMaterial3: true,
),
home: const ChatBotWidget(
config: ChatConfig(
title: 'Support Bot',
themeColor: Color(0xFF007BFF),
initialMessage: 'Hi! How can I help you today?',
profilePicUrl: 'https://i.pravatar.cc/40',
apiKey:
"your-api-key",// See API Key Configuration
),
child: HomePage(),
),
);
}
}
π API Key Configuration #
This package requires a valid API key to enable AI-powered chatbot functionality.
Note
To obtain a customized AI integration API key for your application,
please contact the development team at https://avya.lk/
βοΈ Configuration Options #
| Property | Type | Default | Description |
|---|---|---|---|
title |
String |
required | Title displayed in the chat header |
themeColor |
Color |
Color(0xFF007BFF) |
Primary color for the chat widget |
initialMessage |
String |
'Hi! How can I help you?' |
Bot's greeting message |
inputPlaceholder |
String |
'Type a message' |
Placeholder text in input field |
apiKey |
String? |
null |
API key for backend authentication |
profilePicUrl |
String? |
null |
URL for bot's profile picture |
ποΈ Architecture #
lib/
βββ chatbot_support_kit.dart # Main export file
βββ src/
βββ chat_widget.dart # Main ChatBotWidget
βββ chat_config.dart # ChatConfig configuration class
βββ chat_message.dart # ChatMessage model
βββ chat_service.dart # API/WebSocket service
βββ chat_websocket_client.dart # WebSocket client
π± Platform Support #
| Platform | Supported |
|---|---|
| Android | β |
| iOS | β |
| Web | β |
| macOS | β |
| Windows | β |
| Linux | β |
π€ Contributing #
Contributions are welcome! Please feel free to submit a Pull Request.
π License #
This project is licensed under the MIT License - see the LICENSE file for details.
β€οΈ Support #
If you find this package helpful, please give it a βοΈ on GitHub!
π Issues #
Found a bug? Please file an issue on GitHub.