minor fixes

2021-07-09 15:13:48 +02:00
parent 68f1328a54
commit 7b1a85c40c
22 changed files with 67 additions and 91 deletions
@@ -4,7 +4,7 @@ sidebar_position: 10
 title: ChannelHeader
 ---

-A Widget To Display Common Channel Details
+A Widget to display common channel details

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/ChannelHeader-class.html)

@@ -4,7 +4,7 @@ sidebar_position: 9
 title: ChannelListHeader
 ---

-A Header Widget For A List Of Channels
+A header Widget for a list of channels

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/ChannelListHeader-class.html)

@@ -4,7 +4,7 @@ sidebar_position: 4
 title: ChannelListView
 ---

-A Widget For Displaying A List Of Channels
+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)

@@ -13,9 +13,10 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 ### Background

 Channels are fundamental elements of Stream Chat and constitute shared spaces which allow users to
-message each other. 1:1 conversations and groups are both examples of channels, albeit with some (distinct/non-distinct)
-differences. Displaying the list of channels that a user is a part of is a pattern that is part of
-most messaging apps.
+message each other.
+
+1:1 conversations and groups are both examples of channels, albeit with some (distinct/non-distinct)
+differences. Displaying the list of channels that a user is a part of is a pattern present in most messaging apps.

 The `ChannelListView` widget allows displaying a list of channels to a user. By default, this is NOT
 ONLY the channels that the user is a part of. This section goes into setting up and using a `ChannelListView`
@@ -4,7 +4,7 @@ sidebar_position: 1
 title: Introduction
 ---

-Understanding The UI Package Of The Flutter SDK
+Understanding the UI package of the Flutter SDK

 ### What function does `stream_chat_flutter` serve?

@@ -4,7 +4,7 @@ sidebar_position: 6
 title: MessageInput
 ---

-A Widget Dealing With Everything Related To Sending A Message
+A Widget dealing with everything related to sending a message

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageInput-class.html)

@@ -14,7 +14,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_

 In Stream Chat, we can send messages in a channel. However, sending a message isn't as simple as adding
 a `TextField` and logic for sending a message. It involves additional processes like addition of media,
-quoting a messages, adding a custom command like a GIF board, and much more. Moreover, most apps also
+quoting a message, adding a custom command like a GIF board, and much more. Moreover, most apps also
 need to customize the input to match their theme, overall color and structure pattern, etc.

 To do this, we created a `MessageInput` widget which abstracts all expected functionality a modern input
@@ -54,7 +54,7 @@ class ChannelPage extends StatelessWidget {
 }
 ```

-It is common to put this widget in the same page of a [MessageListView] as the bottom widget.
+It is common to put this widget in the same page of a `MessageListView` as the bottom widget.

 ### Quoting A Message

@@ -119,7 +119,7 @@ class _ChannelPageState extends State<ChannelPage> {

 ### Adding Custom Actions

-By default, the `MessageInput` has two actions: one for attachments and one for commands like giphy.
+By default, the `MessageInput` has two actions: one for attachments and one for commands like Giphy.
 To add your own action, we use the `actions` parameter like this:

 ```dart
@@ -4,7 +4,7 @@ sidebar_position: 5
 title: MessageListView
 ---

-A Widget For Displaying A List Of Messages
+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)

@@ -4,7 +4,7 @@ sidebar_position: 8
 title: MessageSearchListView
 ---

-A Widget To Search For Messages Across Channels
+A Widget to search for messages across channels

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageSearchListView-class.html)

@@ -4,7 +4,7 @@ sidebar_position: 11
 title: MessageWidget
 ---

-A Widget For Displaying Messages And Attachments
+A Widget for displaying messages and attachments

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/MessageWidget-class.html)

@@ -4,7 +4,7 @@ sidebar_position: 2
 title: Setup
 ---

-Understanding Setup For stream_chat_flutter
+Understanding setup for `stream_chat_flutter`

 ### Add pub.dev dependency

@@ -12,7 +12,7 @@ First, you need to add the `stream_chat_flutter` dependency to your `pubspec.yam

 You can either run this command:

-```
+```shell
 flutter pub add stream_chat_flutter
 ```

@@ -20,15 +20,17 @@ OR

 Add this line in the dependencies section of your pubspec.yaml after substituting latest version:

-```
+```yaml
 dependencies:
-  stream_chat_flutter_core: ^latest_version
+  stream_chat_flutter: ^latest_version
 ```

+You can find the package details on [pub.dev](https://pub.dev/packages/stream_chat_flutter).
+
 ### Details On Platform Support

 `stream_chat_flutter` was originally created for Android and iOS mobile platforms. As Flutter matured,
-additional platforms were added and the package now has experimental support for web and desktop as
+support for additional platforms was added and the package now has experimental support for web and desktop as
 [detailed here](https://getstream.io/blog/announcing-experimental-multi-platform-support-for-the-stream-flutter-sdk/).

 However, platforms other than mobile may have additional constraints due to not supporting all plugins,
@@ -44,22 +46,3 @@ Follow [this guide](https://pub.dev/packages/video_player#installation) to fulfi

 To pick images from the camera, we use the [image_picker](https://pub.dev/packages/image_picker) plugin.
 Follow [these instructions](https://pub.dev/packages/image_picker#ios) to check the requirements.
-
-### Setup: Web
-
-Due to Moor web (for offline storage) you need to include the sql.js library:
-
-```
-<!doctype html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <script defer src="sql-wasm.js"></script>
-    <script defer src="main.dart.js" type="application/javascript"></script>
-</head>
-<body></body>
-</html>
-```
-
-You can grab the latest version of sql-wasm.js and sql-wasm.wasm [here](https://github.com/sql-js/sql.js/releases)
-and copy them into your `/web` folder.
@@ -4,7 +4,7 @@ sidebar_position: 7
 title: UserListView
 ---

-A Widget For Displaying And Selecting Users
+A Widget for displaying and selecting users

 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/UserListView-class.html)

@@ -74,7 +74,7 @@ UsersListView(

 ### Selecting Users

-The `UserListView` widget allows selecting users in a list by supplying a selected users and callbacks
+The `UserListView` widget allows selecting users in a list by supplying a selected users list and callbacks
 for when user items are tapped.

 ```dart