cometchat_chat_uikit 6.3.0
cometchat_chat_uikit: ^6.3.0 copied to clipboard
CometChat's Flutter UI Kit offers custom UI components for streamlined text and chat features in your app, designed with developers in mind to minimize development effort.
CometChat Flutter UI Kit #
CometChat's Flutter UI Kit offers a set of prebuilt, customizable UI components that let you add text chat, media messaging, reactions, threads, and voice/video calling to your Flutter app with minimal development effort.
[CometChat Flutter UI Kit]
Features #
- Conversations, Messages & Composer — ready-made list, message, and input widgets with receipts, reactions, replies, and threads.
- Users & Groups — browse users, manage groups, and handle group members.
- Voice & Video Calling — optional calling UI powered by the CometChat Calls SDK.
- Theming & Localization — fully themeable components with built-in translations for many locales.
- Cross-platform — Android, iOS, and Web.
Requirements #
- Flutter SDK >= 3.38.9
- Dart SDK >= 3.10.8
- iOS 16.0+ / Android 5.0+
Installation #
Add the package to your pubspec.yaml:
dependencies:
cometchat_chat_uikit: ^6.1.0
Then run:
flutter pub get
Quick start #
- Create an app in the CometChat Dashboard and note your App ID, Region, and Auth Key.
- Initialize the UI Kit and log a user in:
import 'package:flutter/material.dart';
import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';
Future<void> initCometChat() async {
final uiKitSettings = (UIKitSettingsBuilder()
..subscriptionType = CometChatSubscriptionType.allUsers
..region = '<YOUR_REGION>'
..appId = '<YOUR_APP_ID>'
..authKey = '<YOUR_AUTH_KEY>'
..autoEstablishSocketConnection = true)
.build();
CometChatUIKit.init(
uiKitSettings: uiKitSettings,
onSuccess: (_) {
CometChatUIKit.login('<UID>', onSuccess: (_) {}, onError: (_) {});
},
onError: (_) {},
);
}
- Drop a component into your widget tree:
const SafeArea(child: CometChatConversations());
A complete, runnable sample lives in example/.
Integrate with AI Coding Agents #
CometChat Agent Skills teach your AI coding agent how to build with the CometChat Flutter UI Kit. Ask your agent to "add chat to my app" and it detects your project setup, walks you through a short plan for your approval, and then writes the integration code directly into your existing app, following the official CometChat guides. The skills work with Claude Code, Cursor, GitHub Copilot, Codex, Windsurf, and other popular coding agents.
Run the installer in your project root (requires Node.js 18+):
npx @cometchat/skills add
The skills are installed for Claude Code by default; pass --ide <agent> (for example, --ide cursor) to install them for a different agent. Then open your project in your agent and prompt it with "add chat to my app", or run /cometchat.
To learn more, visit CometChat Agent Skills.
Documentation #
License #
This project is licensed under the MIT License.