update doc
This commit is contained in:
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
## 0.1.6
|
## 0.1.6+3
|
||||||
|
|
||||||
- Add some documentation
|
- Add some documentation
|
||||||
|
|
||||||
|
|||||||
@@ -8,15 +8,40 @@ import './channel_name.dart';
|
|||||||
import 'channel_image.dart';
|
import 'channel_image.dart';
|
||||||
import 'stream_channel.dart';
|
import 'stream_channel.dart';
|
||||||
|
|
||||||
/// Channel header
|
/// 
|
||||||
|
/// 
|
||||||
///
|
///
|
||||||
/// [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].
|
/// Usually you would use this widget as an [AppBar] inside a [Scaffold].
|
||||||
/// However you can also use it as a normal widget.
|
/// 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.
|
/// 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.
|
/// Every part of the widget uses a [StreamBuilder] to render the channel information as soon as it updates.
|
||||||
///
|
///
|
||||||
|
|||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
name: stream_chat_flutter
|
name: stream_chat_flutter
|
||||||
homepage: https://github.com/GetStream/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.
|
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:
|
environment:
|
||||||
sdk: ">=2.1.0 <3.0.0"
|
sdk: ">=2.1.0 <3.0.0"
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Reference in New Issue
Block a user