Merge pull request #1057 from GetStream/v4-doc-fixes

docs(ui): fix names and update tutorials
This commit is contained in:
Salvatore Giordano
2022-04-07 10:50:10 +02:00
committed by GitHub
10 changed files with 74 additions and 52 deletions
@@ -24,7 +24,7 @@ import 'package:stream_chat_flutter/stream_chat_flutter.dart';
/// child: StreamChannel(
/// channel: channel,
/// child: Center(
/// child: ChannelImage(
/// child: ChannelAvatar(
/// channel: channel,
/// ),
/// ),
@@ -136,29 +136,25 @@ typedef MessageListView = StreamMessageListView;
/// ```dart
/// class ChannelPage extends StatelessWidget {
/// const ChannelPage({
/// Key key,
/// Key? key,
/// }) : super(key: key);
///
/// @override
/// Widget build(BuildContext context) {
/// return Scaffold(
/// appBar: ChannelHeader(),
/// body: Column(
/// children: <Widget>[
/// Expanded(
/// child: MessageListView(
/// threadBuilder: (_, parentMessage) {
/// return ThreadPage(
/// Widget build(BuildContext context) => Scaffold(
/// appBar: const StreamChannelHeader(),
/// body: Column(
/// children: <Widget>[
/// Expanded(
/// child: StreamMessageListView(
/// threadBuilder: (_, parentMessage) => ThreadPage(
/// parent: parentMessage,
/// );
/// },
/// ),
/// ),
/// ),
/// ),
/// MessageInput(),
/// ],
/// ),
/// );
/// }
/// const StreamMessageInput(),
/// ],
/// ),
/// );
/// }
/// ```
///
@@ -172,7 +168,7 @@ typedef MessageListView = StreamMessageListView;
/// Modify it to change the widget appearance.
/// {@endtemplate}
class StreamMessageListView extends StatefulWidget {
/// Instantiate a new MessageListView
/// Instantiate a new StreamMessageListView.
const StreamMessageListView({
Key? key,
this.showScrollToBottom = true,
@@ -144,29 +144,25 @@ const _kDefaultMaxAttachmentSize = 20971520; // 20MB in Bytes
/// ```dart
/// class ChannelPage extends StatelessWidget {
/// const ChannelPage({
/// Key key,
/// Key? key,
/// }) : super(key: key);
///
/// @override
/// Widget build(BuildContext context) {
/// return Scaffold(
/// appBar: ChannelHeader(),
/// body: Column(
/// children: <Widget>[
/// Expanded(
/// child: MessageListView(
/// threadBuilder: (_, parentMessage) {
/// return ThreadPage(
/// Widget build(BuildContext context) => Scaffold(
/// appBar: const StreamChannelHeader(),
/// body: Column(
/// children: <Widget>[
/// Expanded(
/// child: StreamMessageListView(
/// threadBuilder: (_, parentMessage) => ThreadPage(
/// parent: parentMessage,
/// );
/// },
/// ),
/// ),
/// ),
/// ),
/// MessageInput(),
/// ],
/// ),
/// );
/// }
/// const StreamMessageInput(),
/// ],
/// ),
/// );
/// }
/// ```
///
@@ -24,7 +24,7 @@ import 'package:stream_chat_flutter/stream_chat_flutter.dart';
/// child: StreamChannel(
/// channel: channel,
/// child: Center(
/// child: ChannelImage(
/// child: StreamChannelAvatar(
/// channel: channel,
/// ),
/// ),