diff --git a/CHANGELOG.md b/CHANGELOG.md index 90cce589..70844d88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -## 0.1.6 +## 0.1.6+3 - Add some documentation diff --git a/lib/src/channel_header.dart b/lib/src/channel_header.dart index dccb80ca..6c6ab6e4 100644 --- a/lib/src/channel_header.dart +++ b/lib/src/channel_header.dart @@ -8,15 +8,40 @@ import './channel_name.dart'; import 'channel_image.dart'; import 'stream_channel.dart'; -/// Channel header +/// ![screenshot](https://raw.githubusercontent.com/GetStream/stream-chat-flutter/master/screenshots/channel_header.png) +/// ![screenshot](https://raw.githubusercontent.com/GetStream/stream-chat-flutter/master/screenshots/channel_header_paint.png) /// -/// [screenshot](https://github.com/GetStream/stream-chat-flutter/blob/master/screenshots/channel_header.png) +/// It shows the current [Channel] information. +/// +/// ```dart +/// +/// class MyApp extends StatelessWidget { +/// final Client client; +/// final Channel channel; +/// +/// MyApp(this.client, this.channel); +/// +/// @override +/// Widget build(BuildContext context) { +/// return MaterialApp( +/// home: StreamChat( +/// client: client, +/// child: StreamChannel( +/// channel: channel, +/// child: Scaffold( +/// appBar: ChannelHeader(), +/// ), +/// ), +/// ), +/// ); +/// } +/// } +/// +/// ``` /// /// Usually you would use this widget as an [AppBar] inside a [Scaffold]. /// However you can also use it as a normal widget. /// -/// It shows the current [Channel] information. -/// /// Make sure to have a [StreamChannel] ancestor in order to provide the information about the channel. /// Every part of the widget uses a [StreamBuilder] to render the channel information as soon as it updates. /// diff --git a/pubspec.yaml b/pubspec.yaml index 2a458f3c..f33d5f4d 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,7 @@ name: stream_chat_flutter homepage: https://github.com/GetStream/stream-chat-flutter description: Stream Chat official Flutter SDK. Build your own chat experience using Dart and Flutter. -version: 0.1.6 +version: 0.1.6+3 environment: sdk: ">=2.1.0 <3.0.0" diff --git a/screenshots/channel_header.png b/screenshots/channel_header.png index e59a9cc7..41b2b77a 100644 Binary files a/screenshots/channel_header.png and b/screenshots/channel_header.png differ diff --git a/screenshots/channel_header_paint.png b/screenshots/channel_header_paint.png new file mode 100644 index 00000000..ba4c6175 Binary files /dev/null and b/screenshots/channel_header_paint.png differ