Skip to content

Commit

Permalink
Merge pull request #1091 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history 
Modify IM Doc
  • Loading branch information
@haoxiuwen
haoxiuwen authored Dec 16, 2024
2 parents efbaa37 + 3e3ae71 commit 7693f13
Show file tree
Hide file tree
Showing 22 changed files with 66 additions and 30 deletions.
0 .../uikit/chatuikit/android/contact list.png → .../uikit/chatuikit/android/contact_list.png
View file
File renamed without changes
Binary file removed docs/.vuepress/public/images/uikit/chatuikit/ios/page_chat.png
View file
Binary file not shown.
Binary file removed docs/.vuepress/public/images/uikit/chatuikit/ios/page_contact_list.png
View file
Binary file not shown.
Binary file removed docs/.vuepress/public/images/uikit/chatuikit/ios/page_conversation.png
View file
Binary file not shown.
Binary file added docs/.vuepress/public/images/uikit/chatuikit/web/chat_details.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.vuepress/public/images/uikit/chatuikit/web/page_chat.png
View file
Binary file not shown.
Binary file removed docs/.vuepress/public/images/uikit/chatuikit/web/page_contact_list.png
View file
Binary file not shown.
Binary file added docs/.vuepress/public/images/uikit/chatuikit/web/user_list.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 8 additions & 6 deletions docs/uikit/chatuikit/android/chatfeature_common.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,15 @@
会话列表呈现了用户所有正在进行的对话，帮助用户快速找到所需联系人并查看消息进展。

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/page_conversation.png" title="会话列表" />
<ImageItem src="/images/uikit/chatuikit/android/main_conversation_list.png" title="会话列表" />
</ImageGallery>

## 聊天

聊天是即时通讯的核心功能之一，它允许用户与其他用户进行实时文字交流。聊天通常以会话的形式进行，每个会话由两个或多个用户组成。

![img](/images/uikit/chatuikit/feature/common/chat.png =350x750)

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/feature/common/chat_android.png" title="聊天页面" />
<ImageItem src="/images/uikit/chatuikit/android/main_chat.png" title="聊天页面" />
</ImageGallery>

## 创建会话
Expand All @@ -44,7 +42,9 @@

用户列表显示了用户的所有联系人，包括联系人列表，群成员列表和黑名单等。用户可以通过用户列表快速找到需要联系的人。

![img](/images/uikit/chatuikit/feature/common/user_list.png =350x760)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/contact_list.png" title="联系人列表" />
</ImageGallery>

## 文件共享

Expand Down Expand Up @@ -86,7 +86,9 @@

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

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

## 本地搜索

Expand Down
2 changes: 1 addition & 1 deletion docs/uikit/chatuikit/android/chatuikit_conversation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
会话列表相关功能，详见[功能介绍文档](chatfeature_conversation.html)。

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/page_conversation.png" title="会话列表" />
<ImageItem src="/images/uikit/chatuikit/android/main_conversation_list.png" title="会话列表" />
</ImageGallery>

## 使用示例
Expand Down
4 changes: 2 additions & 2 deletions docs/uikit/chatuikit/android/chatuikit_overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
Chat Fragment 提供所有聊天视图的容器。

<ImageGallery :columns="3">
<ImageItem src="/images/uikit/chatuikit/android/chat_detail.png" title="聊天页面" />
<ImageItem src="/images/uikit/chatuikit/android/main_chat.png" title="聊天页面" />
<ImageItem src="/images/uikit/chatuikit/android/message_types_2.png" title="发送多种类型的消息" />
<ImageItem src="/images/uikit/chatuikit/android/message_longpress_2.png" title="消息长按操作" />
<ImageItem src="/images/uikit/chatuikit/android/message_reply.png" title="消息引用" />
Expand All @@ -82,7 +82,7 @@ Conversation Fragment 提供会话列表容器。
Contact Fragment 提供联系人、群组及其详情等容器。

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/contact list.png" title="联系人列表" />
<ImageItem src="/images/uikit/chatuikit/android/contact_list.png" title="联系人列表" />
<ImageItem src="/images/uikit/chatuikit/android/contact_detail.png" title="联系人详情" />
<ImageItem src="/images/uikit/chatuikit/android/block_list.png" title="联系人黑名单" />
<ImageItem src="/images/uikit/chatuikit/android/group_list.png" title="群组列表" />
Expand Down
12 changes: 9 additions & 3 deletions docs/uikit/chatuikit/flutter/chatfeature_common.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@

会话列表呈现了用户所有正在进行的对话，帮助用户快速找到所需联系人并查看消息进展。

![img](/images/uikit/chatuikit/feature/common/conversation_list.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_conversation_list.png" title="会话列表" />
</ImageGallery>

## 聊天

聊天是即时通讯的核心功能之一，它允许用户与其他用户进行实时文字交流。聊天通常以会话的形式进行，每个会话由两个或多个用户组成。

![img](/images/uikit/chatuikit/feature/common/chat.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_chat.png" title="聊天页面" />
</ImageGallery>

## 创建会话

Expand All @@ -38,7 +42,9 @@

用户列表显示了用户的所有联系人，包括联系人列表，群成员列表和黑名单等。用户可以通过用户列表快速找到需要联系的人。

![img](/images/uikit/chatuikit/feature/common/user_list.png =350x760)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_contact_list.png" title="用户列表" />
</ImageGallery>

## 文件共享

Expand Down
6 changes: 3 additions & 3 deletions docs/uikit/chatuikit/ios/chatfeature_conversation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

在会话列表页面，你 可以左滑或右滑单个会话进行会话操作，左滑菜单项包括会话免打扰、置顶会话和删除会话，右滑菜单包括会话已读和唤起更多菜单。

![img](/images/uikit/chatuikit/ios/configurationitem/conversation/Appearance_conversation_swipeLeftActions.png)

<Toc />
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/configurationitem/conversation/Appearance_conversation_swipeLeftActions.png" title="会话左滑和右滑" />
</ImageGallery>

## 会话已读

Expand Down
12 changes: 9 additions & 3 deletions docs/uikit/chatuikit/react-native/chatfeature_common.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@

会话列表呈现了用户所有正在进行的对话，帮助用户快速找到所需联系人并查看消息进展。

![img](/images/uikit/chatuikit/feature/common/conversation_list.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_conversation_list.png" title="会话列表" />
</ImageGallery>

## 聊天

聊天是即时通讯的核心功能之一，它允许用户与其他用户进行实时文字交流。聊天通常以会话的形式进行，每个会话由两个或多个用户组成。

![img](/images/uikit/chatuikit/feature/common/chat.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_chat.png" title="聊天页面" />
</ImageGallery>

## 创建会话

Expand All @@ -38,7 +42,9 @@

用户列表显示了用户的所有联系人，包括联系人列表，群成员列表和黑名单等。用户可以通过用户列表快速找到需要联系的人。

![img](/images/uikit/chatuikit/feature/common/user_list.png =350x760)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/main_contact_list.png" title="用户列表" />
</ImageGallery>

## 文件共享

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

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

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

示例代码如下：

Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/react-native/chatuikit_contactlist.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

联系人按照名称首字母分类排序，如果是中文则使用汉字首字母排序，如果没有昵称则使用用户 ID。

![img](/images/uikit/chatuikit/ios/custom_contact_list.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/custom_contact_list.png" title="通讯录" />
</ImageGallery>

默认使用示例如下：

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

会话列表相关功能，详见[功能介绍文档](chatfeature_conversation.html)。

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

使用默认参数时的示例代码如下：

Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/react-native/chatuikit_custom_contact_details.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

对于联系人详情页面，你可以自定义联系人导航栏、联系人列表项和自定义发消息、音频通话、视频通话等按钮。

![img](/images/uikit/chatuikit/ios/custom_contact_details.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/custom_contact_details.png" title="联系人详情页面" />
</ImageGallery>

## 自定义导航栏

Expand Down
4 changes: 3 additions & 1 deletion docs/uikit/chatuikit/react-native/chatuikit_custom_group_details.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

你可以配置群详情页面的导航栏、自定义按钮和群详情列表项等。

![img](/images/uikit/chatuikit/ios/custom_group_details.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/ios/custom_group_details.png" title="群详情页面" />
</ImageGallery>

## 自定义导航栏

Expand Down
12 changes: 9 additions & 3 deletions docs/uikit/chatuikit/uniapp/chatfeature_common.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@

会话列表呈现了用户所有正在进行的对话，帮助用户快速找到所需联系人并查看消息进展。

![img](/images/uikit/chatuikit/feature/common/conversation_list.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/main_conversation_list.png" title="会话列表" />
</ImageGallery>

## 聊天

聊天是即时通讯的核心功能之一，它允许用户与其他用户进行实时文字交流。聊天通常以会话的形式进行，每个会话由两个或多个用户组成。

![img](/images/uikit/chatuikit/feature/common/chat.png =350x750)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/main_chat.png" title="聊天页面" />
</ImageGallery>

## 创建会话

Expand All @@ -32,7 +36,9 @@

用户列表显示了用户的所有联系人，包括联系人列表，群成员列表和黑名单等。用户可以通过用户列表快速找到需要联系的人。

![img](/images/uikit/chatuikit/feature/common/user_list.png =350x760)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/contact_list.png" title="联系人列表" />
</ImageGallery>

## 已发送回执

Expand Down
2 changes: 1 addition & 1 deletion docs/uikit/chatuikit/uniapp/chatuikit_overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
`ChatUIKit/modules/ContactList` 提供联系人列表容器, `ChatUIKit/modules/GroupList` 提供群组列表容器。

<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/android/contact list.png" title="联系人列表" />
<ImageItem src="/images/uikit/chatuikit/android/contact_list.png" title="联系人列表" />
<ImageItem src="/images/uikit/chatuikit/android/group_list.png" title="群组列表" />
</ImageGallery>

Expand Down
12 changes: 9 additions & 3 deletions docs/uikit/chatuikit/web/chatfeature_common.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@

会话列表呈现了用户所有正在进行的对话，帮助用户快速找到所需联系人并查看消息进展。

![img](/images/uikit/chatuikit/feature/web/common/conversation_list.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/web/page_conversation.png" title="会话列表" />
</ImageGallery>

## 聊天

聊天是即时通讯的核心功能之一，它允许用户与其他用户进行实时文字交流。聊天通常以会话的形式进行，每个会话由两个或多个用户组成。

![img](/images/uikit/chatuikit/feature/web/common/chat.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/web/chat_details.png" title="聊天页面" />
</ImageGallery>

## 创建会话

Expand All @@ -38,7 +42,9 @@

用户列表显示了用户的所有联系人，包括联系人列表，群成员列表和黑名单等。用户可以通过用户列表快速找到需要联系的人。

![img](/images/uikit/chatuikit/feature/web/common/user_list.png)
<ImageGallery>
<ImageItem src="/images/uikit/chatuikit/web/user_list.png" title="用户列表" />
</ImageGallery>

## 文件共享

Expand Down

0 comments on commit 7693f13

Please sign in to comment.