https://github.com/talkjs/talkjs-flutter
Flutter SDK for the TalkJS Chat API
https://github.com/talkjs/talkjs-flutter
chat chat-api chatbox dart flutter flutter-components messaging messaging-api
Last synced: about 1 month ago
JSON representation
Flutter SDK for the TalkJS Chat API
- Host: GitHub
- URL: https://github.com/talkjs/talkjs-flutter
- Owner: talkjs
- License: bsd-3-clause
- Created: 2021-05-13T13:35:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T16:43:56.000Z (about 1 month ago)
- Last Synced: 2026-01-29T07:24:59.393Z (about 1 month ago)
- Topics: chat, chat-api, chatbox, dart, flutter, flutter-components, messaging, messaging-api
- Language: Dart
- Homepage: https://talkjs.com
- Size: 507 KB
- Stars: 11
- Watchers: 6
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TalkJS Flutter SDK
Official TalkJS SDK for Flutter
**What is TalkJS?**
TalkJS lets you add user-to-user chat to your marketplace, on-demand app, or
social platform.
For more information, visit
[talkjs.com](https://talkjs.com/?ref=flutter-pub-readme).
Don't hesitate to
[let us know](https://talkjs.com/?chat)
if you have any questions about TalkJS.
## Requirements
- Dart sdk: ">=3.8.0 <4.0.0"
- Flutter: ">=3.32.0"
- Android: `minSDKVersion 23`
## Installation
Edit the dependencies section of your project's `pubspec.yaml` file in your
Flutter project as follows:
```yaml
dependencies:
talkjs_flutter: ^0.1.0
```
Run the command: `flutter pub get` on the command line or through Android
Studio's **Get dependencies** button.
## Usage
Import TalkJS in your project source files.
```dart
import 'package:talkjs_flutter/talkjs_flutter.dart';
```
Then follow our
[Flutter guide](https://talkjs.com/docs/Getting_Started/Frameworks/Flutter/)
to start using TalkJS in your project.
## TalkJS is fully forward compatible
We promise to never break API compatibility.
We may at times deprecate methods or fields, but we will never remove them.
If something that used to work stops working, then that's a bug.
Please [report it](https://talkjs.com/?chat) and we'll fix it asap.
The package is being released in a beta state.
The reason for this is that there are things that one can do with the TalkJS
JavaScript SDK that aren't possible with the Flutter SDK.
We will release v1.0.0 of this package once the two SDKs are similar in terms
of features.
This however does not take away from our commitment to always maintain backward
compatibility.
So you can be assured that the package is stable for production use.