Skip to content

Commit 4c22182

Browse files
author
haoxiuwen
committed
modify
1 parent b9ba73b commit 4c22182

File tree

2 files changed

+140
-39
lines changed

2 files changed

+140
-39
lines changed

‎docs/uikit/chatuikit/flutter/chatuikit_overview.md‎

Lines changed: 60 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,19 +192,71 @@
192192
└── defines.dart // uikit 内部使用 key
193193
```
194194

195-
## 功能
195+
## 功能介绍
196196

197-
单群聊 UIKit 中业务相关的 UI 控件主要包含在以下三个 View 中：
197+
单群聊 UIKit 中业务相关的 UI 控件主要包含三个 View 中：`MessagesView`、`ConversationsView` 和 `ContactsView`。
198198

199-
- MessagesView 提供所有聊天视图。
199+
下图展示单群聊 UIKit 的主要功能：
200200

201-
![img](/images/uikit/chatuikit/android/page_chat.png =400x890)
201+
<ImageGallery>
202+
<ImageItem src="/images/uikit/chatuikit/ios/main_chat.png" title="聊天页面" />
203+
<ImageItem src="/images/uikit/chatuikit/ios/main_conversation_list.png" title="会话列表" />
204+
<ImageItem src="/images/uikit/chatuikit/ios/main_contact_list.png" title="通讯录" />
205+
<ImageItem src="/images/uikit/chatuikit/ios/main_chat_group.png" title="群聊" />
206+
</ImageGallery>
202207

203-
- ConversationsView 提供会话列表。
208+
### 聊天页面功能
204209

205-
![img](/images/uikit/chatuikit/android/page_conversation.png =400x850)
210+
`MessagesView` 提供所有聊天视图。
206211

207-
- ContactsView 提供联系人、群组及其详情等。
212+
<ImageGallery :columns="3">
213+
<ImageItem src="/images/uikit/chatuikit/ios/chat_detail.png" title="聊天页面" />
214+
<ImageItem src="/images/uikit/chatuikit/ios/message_types.png" title="发送多种类型的消息" />
215+
<ImageItem src="/images/uikit/chatuikit/ios/message_longpress.png" title="消息长按操作" />
216+
<ImageItem src="/images/uikit/chatuikit/ios/message_reply.png" title="消息引用" />
217+
<ImageItem src="/images/uikit/chatuikit/ios/message_deliveryreceipt.png" title="已发送回执" />
218+
<ImageItem src="/images/uikit/chatuikit/ios/message_readreceipt.png" title="已读回执" />
219+
</ImageGallery>
220+
221+
### 会话列表页面功能
222+
223+
`ConversationsView` 提供会话列表。
224+
225+
<ImageGallery>
226+
<ImageItem src="/images/uikit/chatuikit/ios/conversation_slide.png" title="会话左滑/右滑" />
227+
<ImageItem src="/images/uikit/chatuikit/ios/conversation_operation.png" title="会话操作" />
228+
</ImageGallery>
229+
230+
### 通讯录页面功能
231+
232+
`ContactsView` 提供联系人、群组及其详情等。
233+
234+
<ImageGallery>
235+
<ImageItem src="/images/uikit/chatuikit/ios/contact_list.png" title="联系人列表" />
236+
<ImageItem src="/images/uikit/chatuikit/ios/contact_detail.png" title="联系人详情" />
237+
<ImageItem src="/images/uikit/chatuikit/ios/block_list.png" title="联系人黑名单" />
238+
<ImageItem src="/images/uikit/chatuikit/ios/group_list.png" title="群组列表" />
239+
</ImageGallery>
240+
241+
### 群组管理页面功能
242+
243+
群组管理页面提供以下功能：
244+
245+
<ImageGallery>
246+
<ImageItem src="/images/uikit/chatuikit/ios/group_detail.png" title="群详情管理" />
247+
<ImageItem src="/images/uikit/chatuikit/ios/group_member.png" title="群成员管理" />
248+
<ImageItem src="/images/uikit/chatuikit/ios/group_thread.png" title="话题" />
249+
<ImageItem src="/images/uikit/chatuikit/ios/group_pin.png" title="消息置顶" />
250+
</ImageGallery>
251+
252+
### 页面搜索功能
253+
254+
单群聊 UIKit 提供以下搜索功能：
255+
256+
<ImageGallery :columns="3">
257+
<ImageItem src="/images/uikit/chatuikit/ios/search_conversation.png" title="搜索会话名称" />
258+
<ImageItem src="/images/uikit/chatuikit/ios/search_contact.png" title="搜索联系人名称" />
259+
<ImageItem src="/images/uikit/chatuikit/ios/search_chat_history.png" title="搜索聊天历史" />
260+
</ImageGallery>
208261

209-
![img](/images/uikit/chatuikit/android/page_contact_list.png =400x850)
210262

‎docs/uikit/chatuikit/react-native/chatuikit_overview.md‎

Lines changed: 80 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -47,48 +47,97 @@
4747
└── tsconfig.json // 编译配置
4848
```
4949

50-
## 功能
50+
## 功能介绍
5151

5252
环信即时通讯 `Chat UIKit SDK` 提供的主要功能包括：主题、国际化、多媒体处理、联系人页面、会话列表、会话详情、错误处理等。
5353

54-
核心组件介绍如下：
54+
### 核心组件
5555

56-
| 组件集合名称 | 描述 |
57-
| ------------ | -------------------------------------------------------------------------------------------------------------------- |
58-
| Container | 入口组件，在应用程序入口使用，设置全局配置和初始化 UI 组件库。 |
59-
| Theme | 主题组件，由 `Palette` 和 `Theme` 组成，可以配置 UI 组件的颜色和样式。 |
60-
| i18n | 国际化组件，默认提供中英文 UI 组件的国际化内容，支持更改内容和自定义目标语言。 |
56+
| 组件集合名称 | 描述 |
57+
| ------------ | ------------ |
58+
| Container | 入口组件，在应用程序入口使用，设置全局配置和初始化 UI 组件库。 |
59+
| Theme | 主题组件，由 `Palette` 和 `Theme` 组成，可以配置 UI 组件的颜色和样式。 |
60+
| i18n | 国际化组件，默认提供中英文 UI 组件的国际化内容，支持更改内容和自定义目标语言。 |
6161
| biz | 页面级业务组件集合。包括`ConversationList`,`ContactList`,`GroupList`, `GroupParticipantList`和`ConversationDetail`等 |
62-
| chat | 消息服务组件。所有关于消息的非页面处理都在这里。 |
63-
| config | 配置服务组件。全局配置设置都在这里。 |
64-
| dispatch | 事件分发组件。可以进行组件之间通信。 |
65-
| error | 对错对象。`uikit`里面的错误错误对象都在这里定义。 |
66-
| hook | 自定义的钩子组件。为其它组件服务。 |
67-
68-
| 页面级组件名称 | 描述 |
69-
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
70-
| ConversationList | 会话列表组件，提供显示和管理会话列表。 |
62+
| chat | 消息服务组件。所有关于消息的非页面处理都在这里。 |
63+
| config | 配置服务组件。全局配置设置都在这里。 |
64+
| dispatch | 事件分发组件。可以进行组件之间通信。 |
65+
| error | 对错对象。`uikit`里面的错误错误对象都在这里定义。 |
66+
| hook | 自定义的钩子组件。为其它组件服务。 |
67+
68+
| 页面级组件名称 | 描述 |
69+
| -------------------- | ------------- |
70+
| ConversationList | 会话列表组件，提供显示和管理会话列表。 |
7171
| ContactList | 联系人列表组件，提供显示和管理联系人列表。在联系人列表、新会话、创建群组、添加群成员、分享名片、转发消息页面中复用。 |
72-
| ConversationDetail | 消息页面组件，可以收发消息、加载历史消息，支持单群聊。在聊天、搜索、话题、创建话题页面中复用。 |
73-
| GroupList | 群组列表组件，提供显示和管理群组列表。 |
74-
| GroupParticipantList | 群成员列表组件，提供显示和管理群成员列表。在添加成员、删除成员、修改群拥有者、多人音视频中复用。 |
75-
| NewRequests | 新通知列表组件，接收和处理好友请求处理。 |
76-
| CreateGroup | 创建群组组件。 |
77-
| ContactInfo | 联系人详情组件。 |
78-
| GroupInfo | 群组详情组件。 |
72+
| ConversationDetail | 消息页面组件，可以收发消息、加载历史消息，支持单群聊。在聊天、搜索、话题、创建话题页面中复用。 |
73+
| GroupList | 群组列表组件，提供显示和管理群组列表。 |
74+
| GroupParticipantList | 群成员列表组件，提供显示和管理群成员列表。在添加成员、删除成员、修改群拥有者、多人音视频中复用。 |
75+
| NewRequests | 新通知列表组件，接收和处理好友请求处理。 |
76+
| CreateGroup | 创建群组组件。 |
77+
| ContactInfo | 联系人详情组件。 |
78+
| GroupInfo | 群组详情组件。 |
7979

80-
## 组件样例
80+
### 主要功能界面
8181

82-
单群聊 UIKit 中业务相关的 UI 控件主要包含在以下三个组件中：
82+
单群聊 UIKit 中业务相关的 UI 控件主要包含在 `ConversationDetail`、`ConversationList` 和 `ContactList` 三个组件中，主要提供以下功能界面：
8383

84-
- `ConversationDetail` 提供会话列表容器。
84+
<ImageGallery>
85+
<ImageItem src="/images/uikit/chatuikit/ios/main_chat.png" title="聊天页面" />
86+
<ImageItem src="/images/uikit/chatuikit/ios/main_conversation_list.png" title="会话列表" />
87+
<ImageItem src="/images/uikit/chatuikit/ios/main_contact_list.png" title="通讯录" />
88+
<ImageItem src="/images/uikit/chatuikit/ios/main_chat_group.png" title="群聊" />
89+
</ImageGallery>
8590

86-
![img](/images/uikit/chatuikit/android/page_chat.png =400x890)
91+
### 聊天页面功能
8792

88-
- `ConversationList` 提供所有聊天视图的容器。
93+
`ConversationDetail` 提供所有聊天视图的容器。
8994

90-
![img](/images/uikit/chatuikit/android/page_conversation.png =400x850)
95+
<ImageGallery :columns="3">
96+
<ImageItem src="/images/uikit/chatuikit/ios/chat_detail.png" title="聊天页面" />
97+
<ImageItem src="/images/uikit/chatuikit/ios/message_types.png" title="发送多种类型的消息" />
98+
<ImageItem src="/images/uikit/chatuikit/ios/message_longpress.png" title="消息长按操作" />
99+
<ImageItem src="/images/uikit/chatuikit/ios/message_reply.png" title="消息引用" />
100+
<ImageItem src="/images/uikit/chatuikit/ios/message_deliveryreceipt.png" title="已发送回执" />
101+
<ImageItem src="/images/uikit/chatuikit/ios/message_readreceipt.png" title="已读回执" />
102+
</ImageGallery>
91103

92-
- `ContactList` 提供联系人、群组及其详情等容器。
104+
### 会话列表页面功能
93105

94-
![img](/images/uikit/chatuikit/android/page_contact_list.png =400x850)
106+
`ConversationList` 提供会话列表容器。
107+
108+
<ImageGallery>
109+
<ImageItem src="/images/uikit/chatuikit/ios/conversation_slide.png" title="会话左滑/右滑" />
110+
<ImageItem src="/images/uikit/chatuikit/ios/conversation_operation.png" title="会话操作" />
111+
</ImageGallery>
112+
113+
### 通讯录页面功能
114+
115+
`ContactList` 提供联系人、群组及其详情等容器。
116+
117+
<ImageGallery>
118+
<ImageItem src="/images/uikit/chatuikit/ios/contact_list.png" title="联系人列表" />
119+
<ImageItem src="/images/uikit/chatuikit/ios/contact_detail.png" title="联系人详情" />
120+
<ImageItem src="/images/uikit/chatuikit/ios/block_list.png" title="联系人黑名单" />
121+
<ImageItem src="/images/uikit/chatuikit/ios/group_list.png" title="群组列表" />
122+
</ImageGallery>
123+
124+
### 群组管理页面功能
125+
126+
群组管理页面提供以下功能：
127+
128+
<ImageGallery>
129+
<ImageItem src="/images/uikit/chatuikit/ios/group_detail.png" title="群详情管理" />
130+
<ImageItem src="/images/uikit/chatuikit/ios/group_member.png" title="群成员管理" />
131+
<ImageItem src="/images/uikit/chatuikit/ios/group_thread.png" title="话题" />
132+
<ImageItem src="/images/uikit/chatuikit/ios/group_pin.png" title="消息置顶" />
133+
</ImageGallery>
134+
135+
### 页面搜索功能
136+
137+
单群聊 UIKit 提供以下搜索功能：
138+
139+
<ImageGallery :columns="3">
140+
<ImageItem src="/images/uikit/chatuikit/ios/search_conversation.png" title="搜索会话名称" />
141+
<ImageItem src="/images/uikit/chatuikit/ios/search_contact.png" title="搜索联系人名称" />
142+
<ImageItem src="/images/uikit/chatuikit/ios/search_chat_history.png" title="搜索聊天历史" />
143+
</ImageGallery>

0 commit comments

Comments
 (0)