feat: Added new docs and images

This commit is contained in:
Deven Joshi
2021-07-07 16:06:10 +05:30
parent 9687d25c9d
commit d1d33cbd67
12 changed files with 18 additions and 2 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 459 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

@@ -6,6 +6,8 @@ title: ChannelHeader
A Widget To Display Common Channel Details A Widget To Display Common Channel Details
![](../assets/channel_header.png)
### Background ### Background
When a user opens a channel, it is helpful to provide context of which channel they are in. This may When a user opens a channel, it is helpful to provide context of which channel they are in. This may
@@ -63,6 +65,8 @@ ChannelHeader(
), ),
``` ```
![](../assets/channel_header_custom_title.png)
### Showing Connection State ### Showing Connection State
The `ChannelHeader` can also display connection state below the tile which shows the user if they The `ChannelHeader` can also display connection state below the tile which shows the user if they
@@ -6,6 +6,8 @@ title: ChannelListHeader
A Header Widget For A List Of Channels A Header Widget For A List Of Channels
![](../assets/channel_list_header.png)
### Background ### Background
A common pattern for most messaging apps is to show a list of Channels (chats) on the first screen A common pattern for most messaging apps is to show a list of Channels (chats) on the first screen
@@ -54,6 +56,8 @@ ChannelListHeader(
), ),
``` ```
![](../assets/channel_list_header_custom_subtitle.png)
The `titleBuilder` param helps you build different titles depending on the connection state: The `titleBuilder` param helps you build different titles depending on the connection state:
```dart ```dart
@@ -8,6 +8,8 @@ A Widget For Displaying A List Of Channels
Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/ChannelListView-class.html) Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/ChannelListView-class.html)
![](../assets/channel_list_view.png)
### Background ### Background
Channels are fundamental elements of Stream Chat and constitute shared spaces which allow users to Channels are fundamental elements of Stream Chat and constitute shared spaces which allow users to
@@ -8,6 +8,8 @@ A Widget For Displaying A List Of Messages
Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageListView-class.html) Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageListView-class.html)
![](../assets/message_list_view.png)
### Background ### Background
Every channel can contain a list of messages sent by users inside it. The `MessageListView` widget Every channel can contain a list of messages sent by users inside it. The `MessageListView` widget
@@ -68,6 +70,8 @@ MessageListView(
), ),
``` ```
![](../assets/message_list_view_threads.png)
The `MessageListView` itself can render the thread by supplying the `parentMessage` parameter. The `MessageListView` itself can render the thread by supplying the `parentMessage` parameter.
```dart ```dart
@@ -86,7 +90,7 @@ Note: To customize the existing implementation, look at the `MessageWidget` docu
MessageListView( MessageListView(
messageBuilder: (context, details, messageList, defaultImpl) { messageBuilder: (context, details, messageList, defaultImpl) {
// Your implementation of the message here // Your implementation of the message here
// E.g: return Text(details.message.text); // E.g: return Text(details.message.text ?? '');
}, },
), ),
``` ```
@@ -104,4 +108,6 @@ MessageListView(
), ),
``` ```
This will allow these user types to pin messages through the message actions modal. This will allow these user types to pin messages through the message actions modal.
![](../assets/message_list_view_pin.png)