Skip to content

chore: 📖 Update documentation & banner #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aditya-css merged 1 commit into from
Oct 10, 2025
Merged

chore: 📖 Update documentation & banner #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions doc/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ Flutter applications with [Flexible Backend Integration](https://pub.dev/package
- User online status indicators
- Typing indicators for active users
- Unread message count badges
- Connect ChatView to any backend
using [chatview_connect](https://pub.dev/packages/chatview_connect)
- And a wide range of configuration options to customize your chat.
- Internationalization support
- Header and Footer support for additional widgets
- Highly customizable UI components with Internationalization support
- Plug-and-play backend support using [chatview_connect](https://pub.dev/packages/chatview_connect)

### ChatView:

Expand All @@ -46,10 +45,10 @@ For a live web demo, visit [Chat View Example](https://simformsolutionspvtltd.gi

## Compatibility with [chatview_connect](https://pub.dev/packages/chatview_connect)

| `chatview` version | [chatview_connect](https://pub.dev/packages/chatview_connect) version |
|--------------------|-----------------------------------------------------------------------|
| `>=2.4.1 <3.0.0` | `0.0.1` |
| `>= 3.0.0` | `0.0.2` |
| chatview version | [chatview_connect](https://pub.dev/packages/chatview_connect) version |
|------------------|-----------------------------------------------------------------------|
| `>=2.4.1 <3.0.0` | `0.0.1` |
| `>= 3.0.0` | `0.0.2` |

## Compatible Message Types

Expand Down Expand Up @@ -121,7 +120,7 @@ minSdkVersion 21
<uses-permission android:name="android.permission.RECORD_AUDIO"/>
```

# Basic ChatViewList Usage
# ChatViewList - Basic Usage

Here's how to integrate ChatViewList into your Flutter application with minimal setup:

Expand Down Expand Up @@ -201,7 +200,7 @@ List<ChatViewListItem> chatList = [
];
```

# Advanced ChatViewList Usage
# ChatViewList - Advanced Usage

ChatViewList offers extensive customization options to tailor the chat list UI to your specific needs.

Expand Down Expand Up @@ -535,7 +534,7 @@ ChatViewList(
)
```

# Basic ChatView Usage
# ChatView - Basic Usage

Here's how to integrate ChatView into your Flutter application with minimal setup:

Expand Down Expand Up @@ -606,7 +605,7 @@ void onSendTap(String message, ReplyMessage replyMessage, MessageType messageTyp

> Note: You can evaluate message type from the 'messageType' parameter and perform operations accordingly.

# Advanced ChatView Usage
# ChatView - Advanced Usage

ChatView offers extensive customization options to tailor the chat UI to your specific needs.

Expand Down
Binary file modified preview/banner.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 1 addition & 4 deletions pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ dependencies:
any_link_preview: ^3.0.2
audio_waveforms: ^1.2.0
cached_network_image: ^3.4.1
# TODO(YASH): Use pub.dev version once chatview_utils latest version is released
chatview_utils:
git:
url: https://github.com/SimformSolutionsPvtLtd/chatview_utils
chatview_utils: ^0.0.2

emoji_picker_flutter: ^4.3.0
flutter:
Expand Down