cometchat/cometchat-uikit-flutter

CometChat

CometChat UIKit for Flutter

CometChat UIKit for Flutter provides pre-built UI components to quickly add chat, voice, and video calling features to your Flutter application.

CometChat UIKit Screens

Repository Structure

Directory	Description
packages/cometchat_uikit	The open source UIKit package (local setup, structure, tests)
packages/cometchat_uikit/skills	Kiro AI skills for consumers and contributors
examples/sample_app	Sample app demonstrating UIKit usage
examples/ai_sample_app	AI-powered sample app with CometChat AI agents

Prerequisites

• Flutter SDK >= 3.27.0
• Dart SDK >= 3.6.0
• iOS 16.0+ / Android 5.0+
• A CometChat account with App ID and Auth Key

Getting Started

1. Sign up at the CometChat Dashboard and create a new app.
2. Note your App ID, Region, and Auth Key from the dashboard.
3. Clone this repository and navigate to the sample app:

git clone https://github.com/cometchat/cometchat-uikit-flutter.git
cd cometchat-uikit-flutter/examples/sample_app
flutter pub get
flutter run

4. On first launch, enter your App ID, Region, and Auth Key in the credentials screen.

Installation

Add the UIKit to your project's pubspec.yaml:

dependencies:
  cometchat_chat_uikit: ^6.1.0

Then run:

flutter pub get

Documentation

Refer to our official documentation for detailed setup and usage guides.

Help and Support

For issues running the project or integrating with our UI Kit, consult our documentation or create a support ticket or seek real-time support via the CometChat Dashboard.

License

This project is licensed under the terms of the LICENSE file.