Official Flutter SDK for Stream Chat
The official Flutter components for Stream Chat, a service for building chat applications.
Quick Links
- Register to get an API key for Stream Chat
- Flutter Chat Tutorial
- Chat UI Kit
The best place to start is the Flutter Chat Tutorial. It teaches you how to use this SDK and also shows how to make frequently required changes.
This repo includes a fully functional example app with setup instructions. The example is available under the example folder.
dependencies:
stream_chat_flutter: ^0.2.1
You should then run flutter packages get
All set โ
The library uses flutter file picker plugin to pick files from the os. Follow this wiki to fulfill iOS requirements.
We also use video_player to reproduce videos. Follow this guide to fulfill the requirements.
To pick images from the camera, we use the image_picker plugin. Follow these instructions to check the requirements.
We provide 3 Widgets dedicated to business logic and state management:
These are the available Widgets that you can use to build your application UI.
Every widget uses the StreamChat
or StreamChannel
widgets to manage the state and communicate with Stream services.
- ChannelHeader
- ChannelImage
- ChannelListView
- ChannelName
- ChannelPreview
- MessageInput
- MessageListView
- MessageWidget
- StreamChatTheme
- ThreadHeader
- ...
The Flutter SDK comes with a fully designed set of widgets that you can customize to fit with your application style and typography.
Changing the theme of Chat widgets works in a very similar way that MaterialApp
and Theme
do.
Out of the box, all chat widgets use their default styling, and there are two ways to change the styling:
- Initialize the
StreamChatTheme
from your existingMaterialApp
style
class MyApp extends StatelessWidget {
final Client client;
MyApp(this.client);
@override
Widget build(BuildContext context) {
final theme = ThemeData(
primarySwatch: Colors.green,
);
return MaterialApp(
theme: theme,
builder: (context, child) => StreamChat(
child: child,
client: client,
streamChatThemeData: StreamChatThemeData.fromTheme(theme),
),
home: ChannelListPage(),
);
}
}
- Construct a custom theme and provide all the customizations needed
class MyApp extends StatelessWidget {
final Client client;
MyApp(this.client);
@override
Widget build(BuildContext context) {
final theme = ThemeData(
primarySwatch: Colors.green,
);
return MaterialApp(
theme: theme,
builder: (context, child) => StreamChat(
child: child,
client: client,
streamChatThemeData: StreamChatThemeData.fromTheme(theme).copyWith(
ownMessageTheme: MessageTheme(
messageBackgroundColor: Colors.black,
messageText: TextStyle(
color: Colors.white,
),
avatarTheme: AvatarTheme(
borderRadius: BorderRadius.circular(8),
),
),
),
),
home: ChannelListPage(),
);
}
}
By default the library saves information about channels and messages in a SQLite DB.
Set the property persistenceEnabled
to false if you don't want to use the offline storage.
We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are pleased to merge your code into the official repository. Make sure to sign our Contributor License Agreement (CLA) first. See our license file for more details.