Skip to content

Commit

Permalink
Merge pull request #1126 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Add New Type of UIKit Images
  • Loading branch information
haoxiuwen authored Jan 9, 2025
2 parents 025b651 + 73c1415 commit c6f4194
Show file tree
Hide file tree
Showing 70 changed files with 239 additions and 80 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified docs/.vuepress/public/images/uikit/chatuikit/ios/buildError.png
Diff not rendered.
Binary file modified docs/.vuepress/public/images/uikit/chatuikit/ios/login.png
Binary file modified docs/.vuepress/public/images/uikit/chatuikit/web/cvs-bg.png
Binary file modified docs/.vuepress/public/images/uikit/chatuikit/web/cvs-header1.png
44 changes: 34 additions & 10 deletions docs/uikit/chatuikit/android/chatfeature_common.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,25 @@

创建会话是即时通讯的核心功能之一,它允许用户启动与一个或多个其他用户交流。

![img](/images/uikit/chatuikit/feature/common/conversation_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/conversation_create.png" title="创建会话" />
</ImageGallery>

## 创建群组

群组是允许多个用户加入的聊天会话。用户可以邀请其他用户加入群组,并对群组进行管理。

![img](/images/uikit/chatuikit/feature/common/group_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/group_create.png" title="创建群组" />
</ImageGallery>

## 群组管理员

群组管理员拥有对群组的所有权限,包括:添加或删除群成员,修改群组名称、描述和头像,禁言或踢出群成员等。

![img](/images/uikit/chatuikit/feature/common/group_admin.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/group_admin.png" title="群组管理员" />
</ImageGallery>

## 用户列表

Expand All @@ -50,37 +56,49 @@

文件共享允许用户通过即时通讯应用发送和接收文件。文件共享可以用于分享文档、图片、视频等文件。

![img](/images/uikit/chatuikit/feature/common/file_share.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/file_share.png" title="文件共享" />
</ImageGallery>

## 未读消息数

未读消息数是指用户收到的但尚未查看的消息数量。

![img](/images/uikit/chatuikit/feature/common/message_unread_count.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/message_unread_count.png" title="未读消息数" />
</ImageGallery>

## 已发送回执

已发送回执用于告知消息发送者,其发送的消息已经成功发送到服务器、接收方以及发送失败。

![img](/images/uikit/chatuikit/feature/common/message_delivery_receipt.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/message_delivery_receipt.png" title="已发送回执 " />
</ImageGallery>

## 已读回执

已读回执用于告知消息发送者,接收者已经阅读了其发送的消息。

![img](/images/uikit/chatuikit/feature/common/message_read_receipt.png =300x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/message_read_receipt.png" title="已读回执" />
</ImageGallery>

## 联系人名片

联系人名片指包含联系人详细信息的电子卡片,通常包括头像和昵称等信息。通过联系人名片,用户可以快速添加联系人或开始会话。

![img](/images/uikit/chatuikit/feature/common/contact_namecard.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/contact_namecard.png" title="联系人名片" />
</ImageGallery>

## 语音消息

语音消息指以语音形式发送和接收的消息,可替代文字交流。

![img](/images/uikit/chatuikit/feature/common/message_audio.png =700x730)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/message_audio.png" title="语音消息" />
</ImageGallery>

## 消息审核

Expand All @@ -100,7 +118,9 @@ UIKit 提供封装的 `ChatUIKitSearchActivity` 搜索页面,用户根据 `Cha

例如,以下为搜索消息的页面。

![img](/images/uikit/chatuikit/feature/common/message_search.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/message_search.png" title="本地消息搜索" />
</ImageGallery>

#### 如何使用

Expand Down Expand Up @@ -136,6 +156,10 @@ UIKit 提供封装的 `ChatUIKitSearchActivity` 搜索页面,用户根据 `Cha

群组 @ 提及功能使用户能在群聊中通过 @ 符号直接提及特定成员,被提及者将收到特别通知。该功能便于高效传递重要信息,确保关键消息得到及时关注和回应。

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/android/[email protected]" title="群组 @ 提及" />
</ImageGallery>

#### 如何使用

群组 @ 提及特性默认开启。要关闭该特性,则需将 `enableMention` 设置为 `false`
Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/android/chatuikit_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,9 @@ fun Context.showToast(msg: String) {

在聊天页面下方输入消息,然后点击**发送**按钮发送消息。

![img](/images/uikit/chatuikit/android/message_first.png =300x650)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/message_first.png" title="发送第一条消息" />
</ImageGallery>

## 测试应用

Expand Down
2 changes: 1 addition & 1 deletion docs/uikit/chatuikit/android/chatuikit_theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ EaseChatUIKit 内置浅色和深色主题,默认为浅色主题。
- 深色主题

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/dark_mode.png" title="浅色主题" />
<ImageItem src="/images/uikit/chatuikit/android/dark_mode.png" title="深色主题" />
</ImageGallery>

## 实现方式
Expand Down
48 changes: 36 additions & 12 deletions docs/uikit/chatuikit/flutter/chatfeature_common.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,25 @@

创建会话是即时通讯的核心功能之一,它允许用户启动与一个或多个其他用户交流。

![img](/images/uikit/chatuikit/feature/common/conversation_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/conversation_create.png" title="创建会话" />
</ImageGallery>

## 创建群组

群组是允许多个用户加入的聊天会话。用户可以邀请其他用户加入群组,并对群组进行管理。

![img](/images/uikit/chatuikit/feature/common/group_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/group_create.png" title="创建群组" />
</ImageGallery>

## 群组管理员

群组管理员拥有对群组的所有权限,包括:添加或删除群成员,修改群组名称、描述和头像,禁言或踢出群成员等。

![img](/images/uikit/chatuikit/feature/common/group_admin.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/group_admin.png" title="群组管理员" />
</ImageGallery>

## 用户列表

Expand All @@ -50,55 +56,73 @@

文件共享允许用户通过即时通讯应用发送和接收文件。文件共享可以用于分享文档、图片、视频等文件。

![img](/images/uikit/chatuikit/feature/common/file_share.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/file_share.png" title="文件共享" />
</ImageGallery>

## 未读消息数

未读消息数是指用户收到的但尚未查看的消息数量。

![img](/images/uikit/chatuikit/feature/common/message_unread_count.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_unread_count.png" title="未读消息数" />
</ImageGallery>

## 已发送回执

已发送回执用于告知消息发送者,其发送的消息已经成功发送到服务器、接收方以及发送失败。

![img](/images/uikit/chatuikit/feature/common/message_delivery_receipt.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_delivery_receipt.png" title="已发送回执 " />
</ImageGallery>

## 已读回执

已读回执用于告知消息发送者,接收者已经阅读了其发送的消息。

![img](/images/uikit/chatuikit/feature/common/message_read_receipt.png =300x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_read_receipt.png" title="已读回执" />
</ImageGallery>

## 联系人名片

联系人名片指包含联系人详细信息的电子卡片,通常包括头像和昵称等信息。通过联系人名片,用户可以快速添加联系人或开始会话。

![img](/images/uikit/chatuikit/feature/common/contact_namecard.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/contact_namecard.png" title="联系人名片" />
</ImageGallery>

## 语音消息

语音消息指以语音形式发送和接收的消息,可替代文字交流。

![img](/images/uikit/chatuikit/feature/common/message_audio.png =700x730)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_audio.png" title="语音消息" />
</ImageGallery>

## 消息审核

消息审核对用户发送的消息内容进行审查,判断其是否符合平台的社区准则、服务条款和相关法律法规。

![img](/images/uikit/chatuikit/feature/common/message_report.png =300x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_report.png" title="消息审核" />
</ImageGallery>

## 本地消息搜索

本地消息搜索功能允许用户快速在会话内搜索历史消息内容,支持关键词匹配。该功能帮助用户高效找到所需信息,提高工作效率和信息管理的便捷性。

在消息搜索页面,输入关键字搜索当前会话的历史消息,如果有结果会以列表的形式返回,点击搜索结果可以跳转到该消息的位置。

![img](/images/uikit/chatuikit/feature/common/message_search.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_search.png" title="本地消息搜索" />
</ImageGallery>

## 群组 @ 提及

群组 @ 提及功能使用户能在群聊中通过 @ 符号直接提及特定成员,被提及者将收到特别通知。该功能便于高效传递重要信息,确保关键消息得到及时关注和回应。

![img](/images/uikit/chatuikit/feature/common/[email protected])
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/[email protected]" title="群组 @ 提及" />
</ImageGallery>

4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/flutter/chatuikit_chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@

消息相关功能,详见[功能介绍文档](chatfeature_message.html)

![img](/images/uikit/chatuikit/flutter/custom_chat.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/flutter/custom_chat.png" title="聊天页面" />
</ImageGallery>

## 添加消息页面

Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/flutter/chatuikit_conversation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

对于单聊和群聊, 会话展示的名称为你设置的 Profile 中的昵称,若未获取到昵称,则展示 ID;会话头像为你设置的 Profile 中的头像,如果没有设置,则使用默认头像。

![img](/images/uikit/chatuikit/flutter/custom_conversation_list.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/flutter/custom_conversation_list.png" title="会话列表" />
</ImageGallery>

## 添加会话列表

Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/flutter/chatuikit_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,9 @@ ChatUIKit.instance.loginWithToken(userId: userId, token: token);

在聊天页面下方输入消息,然后点击**发送**按钮发送消息。

![img](/images/uikit/chatuikit/android/message_first.png =300x650)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/message_first.png" title="发送第一条消息" />
</ImageGallery>

## 参考

Expand Down
50 changes: 38 additions & 12 deletions docs/uikit/chatuikit/ios/chatfeature_common.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,27 @@

创建会话是即时通讯的核心功能之一,它允许用户启动与一个或多个其他用户交流。

![img](/images/uikit/chatuikit/feature/common/conversation_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/conversation_create.png" title="创建会话" />
</ImageGallery>

## 创建群组

群组是允许多个用户加入的聊天会话。用户可以邀请其他用户加入群组,并对群组进行管理。

![img](/images/uikit/chatuikit/feature/common/group_create.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/group_create.png" title="创建群组" />
</ImageGallery>

## 群组管理员

群组管理员拥有对群组的所有权限,包括:添加或删除群成员,修改群组名称、描述和头像,禁言或踢出群成员等。

![img](/images/uikit/chatuikit/feature/common/group_admin.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/group_admin.png" title="群组管理员" />
</ImageGallery>



## 用户列表

Expand All @@ -50,43 +58,57 @@

文件共享允许用户通过即时通讯应用发送和接收文件。文件共享可以用于分享文档、图片、视频等文件。

![img](/images/uikit/chatuikit/feature/common/file_share.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/file_share.png" title="文件共享" />
</ImageGallery>

## 未读消息数

未读消息数是指用户收到的但尚未查看的消息数量。

![img](/images/uikit/chatuikit/feature/common/message_unread_count.png =600x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_unread_count.png" title="未读消息数" />
</ImageGallery>

## 已发送回执

已发送回执用于告知消息发送者,其发送的消息已经成功发送到服务器、接收方以及发送失败。

![img](/images/uikit/chatuikit/feature/common/message_delivery_receipt.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_delivery_receipt.png" title="已发送回执 " />
</ImageGallery>

## 已读回执

已读回执用于告知消息发送者,接收者已经阅读了其发送的消息。

![img](/images/uikit/chatuikit/feature/common/message_read_receipt.png =300x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_read_receipt.png" title="已读回执" />
</ImageGallery>

## 联系人名片

联系人名片指包含联系人详细信息的电子卡片,通常包括头像和昵称等信息。通过联系人名片,用户可以快速添加联系人或开始会话。

![img](/images/uikit/chatuikit/feature/common/contact_namecard.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/contact_namecard.png" title="联系人名片" />
</ImageGallery>

## 语音消息

语音消息指以语音形式发送和接收的消息,可替代文字交流。

![img](/images/uikit/chatuikit/feature/common/message_audio.png =700x730)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_audio.png" title="语音消息" />
</ImageGallery>

## 消息审核

消息审核对用户发送的消息内容进行审查,判断其是否符合平台的社区准则、服务条款和相关法律法规。

![img](/images/uikit/chatuikit/feature/common/message_report.png =300x630)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_report.png" title="消息审核" />
</ImageGallery>

## 本地消息搜索

Expand All @@ -98,7 +120,9 @@
- `SearchResultMessagesController` 为搜索结果的页面,展示搜索结果的消息列表。
- `SearchHistoryMessageCell`为搜索历史消息的 cell,展示搜索结果的消息列表。

![img](/images/uikit/chatuikit/feature/common/message_search.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/message_search.png" title="本地消息搜索" />
</ImageGallery>

#### 如何使用

Expand All @@ -121,7 +145,9 @@

首先在 `MessageListController``MessageListView` 中的 `MessageInputBar`中输入 `@` 字符后会告知 `ViewModel` 以及 `Controller` 用户输入了 `@` 字符,选择 @ 的用户后,输入框中会显示被 @ 的用户的名字或者昵称。

![img](/images/uikit/chatuikit/feature/common/[email protected])
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/ios/[email protected]" title="群组 @ 提及" />
</ImageGallery>

#### 如何使用

Expand Down
Loading

0 comments on commit c6f4194

Please sign in to comment.