feat: Added new docs and images
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 36 KiB |
|
After Width: | Height: | Size: 1.1 MiB |
|
After Width: | Height: | Size: 1.4 MiB |
|
After Width: | Height: | Size: 459 KiB |
|
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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 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(
|
|||||||
),
|
),
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 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(
|
|||||||
),
|
),
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
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)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 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)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 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(
|
|||||||
),
|
),
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|

|
||||||
|
|||||||