Installation

This page covers how to add the Stream Chat Flutter packages to your project. If you are not sure which package to start with, pick stream_chat_flutter — it ships the full UI on top of the state and low-level packages and covers the vast majority of integrations. See the Introduction for the full decision tree and versioning strategy.

Check the pub.dev page for the latest version number, and pin to a caret constraint with all three version numbers (e.g. ^10.0.0) to avoid pulling in unexpected breaking changes.

Adding the UI SDK

For most apps, add stream_chat_flutter to your pubspec.yaml:

dependencies:
  stream_chat_flutter: ^latest_version

stream_core_flutter is an internal package and is pulled in automatically — you do not need to add it manually unless you use its APIs directly.

Adding a Lower-Level Package

If you only need controllers and builders (no UI), use stream_chat_flutter_core:

dependencies:
  stream_chat_flutter_core: ^latest_version

If you only need the low-level client (pure Dart, no Flutter dependency), use stream_chat:

dependencies:
  stream_chat: ^latest_version

Optional Packages

For offline persistence, add stream_chat_persistence. It works with any of the packages above:

dependencies:
  stream_chat_persistence: ^latest_version

For built-in translations of the UI SDK strings, add stream_chat_localizations:

dependencies:
  stream_chat_localizations: ^latest_version

After updating pubspec.yaml, fetch the packages:

flutter pub get