fix(doc): fix broken documentation snippets

This commit is contained in:
Efthymis Sarmpanis
2023-10-11 15:05:12 +03:00
parent 31950419ee
commit b4dc9defd1
33 changed files with 222 additions and 188 deletions
@@ -28,13 +28,13 @@ and send messages.
```dart
class ChannelPage extends StatelessWidget {
const ChannelPage({
Key key,
}) : super(key: key);
super.key,
});
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: StreaChannelHeader(),
appBar: const StreamChannelHeader(),
body: Column(
children: <Widget>[
Expanded(
@@ -46,7 +46,7 @@ class ChannelPage extends StatelessWidget {
},
),
),
StreamMessageInput(),
const StreamMessageInput(),
],
),
);
@@ -27,9 +27,9 @@ common Channels Page.
```dart
class ChannelListPage extends StatefulWidget {
const ChannelListPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);
});
final StreamChatClient client;
@@ -55,7 +55,7 @@ class _ChannelListPageState extends State<ChannelListPage> {
@override
Widget build(BuildContext context) => Scaffold(
appBar: StreamChannelListHeader(),
appBar: const StreamChannelListHeader(),
body: RefreshIndicator(
onRefresh: _controller.refresh,
child: StreamChannelListView(
@@ -33,9 +33,9 @@ Here is a basic example of the `StreamChannelListView` widget. It consists of th
```dart
class ChannelListPage extends StatefulWidget {
const ChannelListPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);
});
final StreamChatClient client;
@@ -21,11 +21,11 @@ See the [StreamMemberListView](./stream_member_list_view.mdx) documentation for
```dart
class MemberGridPage extends StatefulWidget {
const MemberGridPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);
});
final StreamChatClient client;
final Channel channel;
@override
State<MemberGridPage> createState() => _MemberGridPageState();
@@ -33,13 +33,13 @@ class MemberGridPage extends StatefulWidget {
class _MemberGridPageState extends State<MemberGridPage> {
late final _controller = StreamMemberListController(
client: widget.client,
channel: widget.channel,
limit: 25,
filter: Filter.and([
Filter.notEqual('id', StreamChat.of(context).currentUser!.id),
]),
sort: [
SortOption(
const SortOption(
'name',
direction: 1,
),
@@ -58,13 +58,16 @@ class _MemberGridPageState extends State<MemberGridPage> {
onRefresh: _controller.refresh,
child: StreamMemberGridView(
controller: _controller,
onChannelTap: (channel) => Navigator.push(
onMemberTap: (member) => Navigator.push(
context,
MaterialPageRoute(
builder: (_) => StreamChannel(
channel: channel,
child: const ChannelPage(),
),
builder: (_) => Scaffold(
body: Center(
child: StreamUserAvatar(
user: member.user!,
),
),
),
),
),
),
@@ -20,7 +20,7 @@ Make sure to check the [StreamMemberListController](../04-stream_chat_flutter_co
```dart
class MemberListPage extends StatefulWidget {
const MemberListPage({Key? key}) : super(key: key);
const MemberListPage({super.key});
@override
State<MemberListPage> createState() => _MemberListPageState();
@@ -29,7 +29,7 @@ class MemberListPage extends StatefulWidget {
class _MemberListPageState extends State<MemberListPage> {
late final StreamMemberListController _memberListController =
StreamMemberListController(
client: StreamChat.of(context).client,
channel: StreamChannel.of(context).channel,
limit: 25,
filter: Filter.and(
[Filter.notEqual('id', StreamChat.of(context).currentUser!.id)],
@@ -62,7 +62,7 @@ You can use your own widget for the member items using the `itemBuilder` paramet
StreamMemberListView(
// ...
itemBuilder: (context, members, index, defaultWidget) {
return Text(members[index].name);
return Text(members[index].user!.name);
},
),
```
@@ -71,8 +71,8 @@ StreamMessageInput(
InkWell(
child: Icon(
Icons.location_on,
size: 20.0,
color: StreamChatTheme.of(context).colorTheme.grey,
size: 20,
color: Colors.grey,
),
onTap: () {
// Do something here
@@ -29,19 +29,19 @@ An example of how you can use the `StreamMessageListView` is:
```dart
class ChannelPage extends StatelessWidget {
const ChannelPage({
Key key,
}) : super(key: key);
super.key,
});
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: StreamChannelHeader(),
appBar: const StreamChannelHeader(),
body: Column(
children: <Widget>[
Expanded(
child: StreamMessageListView(),
),
StreamMessageInput(),
const StreamMessageInput(),
],
),
);
@@ -21,9 +21,9 @@ Make sure to check the [StreamMessageSearchListView](./stream_message_search_lis
```dart
class StreamMessageSearchPage extends StatefulWidget {
const StreamMessageSearchPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);`
});
final StreamChatClient client;
@@ -35,7 +35,10 @@ class _StreamMessageSearchState extends State<StreamMessageSearchPage> {
late final _controller = StreamMessageSearchListController(
client: widget.client,
limit: 20,
filters: Filter.in_('members', [StreamChat.of(context).user!.id],),
filter: Filter.in_(
'members',
[StreamChat.of(context).user!.id],
),
searchQuery: 'your query here',
);
@@ -49,6 +52,9 @@ class _StreamMessageSearchState extends State<StreamMessageSearchPage> {
Widget build(BuildContext context) => Scaffold(
body: StreamMessageSearchGridView(
controller: _controller,
itemBuilder: (context, values, index) {
// return your custom widget here
},
),
);
}
@@ -27,9 +27,9 @@ While the `StreamMessageListView` is tied to a certain `StreamChannel`, a `Strea
```dart
class StreamMessageSearchPage extends StatefulWidget {
const StreamMessageSearchPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);`
});
final StreamChatClient client;
@@ -41,7 +41,10 @@ class _StreamMessageSearchState extends State<StreamMessageSearchPage> {
late final _controller = StreamMessageSearchListController(
client: widget.client,
limit: 20,
filters: Filter.in_('members', [StreamChat.of(context).user!.id],),
filter: Filter.in_(
'members',
[StreamChat.of(context).user!.id],
),
searchQuery: 'your query here',
);
@@ -25,8 +25,8 @@ a default implementation of the widget for us to modify.
```dart
class ChannelPage extends StatelessWidget {
const ChannelPage({
Key key,
}) : super(key: key);
super.key,
});
@override
Widget build(BuildContext context) {
@@ -21,9 +21,9 @@ Make sure to check the [StreamUserListView](./stream_user_list_view.mdx) documen
```dart
class UserGridPage extends StatefulWidget {
const UserGridPage({
Key? key,
super.key,
required this.client,
}) : super(key: key);
});
final StreamChatClient client;
@@ -39,7 +39,7 @@ class _UserGridPageState extends State<UserGridPage> {
Filter.notEqual('id', StreamChat.of(context).currentUser!.id),
]),
sort: [
SortOption(
const SortOption(
'name',
direction: 1,
),
@@ -58,12 +58,15 @@ class _UserGridPageState extends State<UserGridPage> {
onRefresh: _controller.refresh,
child: StreamUserGridView(
controller: _controller,
onChannelTap: (channel) => Navigator.push(
onMemberTap: (member) => Navigator.push(
context,
MaterialPageRoute(
builder: (_) => StreamChannel(
channel: channel,
child: const ChannelPage(),
builder: (_) => Scaffold(
body: Center(
child: StreamUserAvatar(
user: member.user!,
),
),
),
),
),
@@ -24,7 +24,7 @@ Make sure to check the [StreamUserListController](../04-stream_chat_flutter_core
```dart
class UserListPage extends StatefulWidget {
const UserListPage({Key? key}) : super(key: key);
const UserListPage({super.key});
@override
State<UserListPage> createState() => _UserListPageState();
@@ -66,7 +66,7 @@ You can use your own widget for the user items using the `itemBuilder` parameter
StreamUsersListView(
// ...
itemBuilder: (context, users, index, defaultWidget) {
return Text(user[index].name);
return Text(users[index].name);
},
),
```