@tencent-rtc/mcp 1.6.7 → 1.6.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/knowledge/build-index.js +3 -0
- package/knowledge/content-loader.js +3 -1
- package/knowledge/search/filter-pool.js +12 -4
- package/knowledge/search/query-normalizer.js +76 -0
- package/knowledge/search/search-knowledge.js +104 -5
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/_schema/query-normalization.yaml +9 -0
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +3 -14
- package/resource/integration/callkit/preset/flutter/integration.md +1 -12
- package/resource/integration/callkit/preset/ios/integration.md +2 -12
- package/resource/integration/callkit/preset/react/integration.md +1 -14
- package/resource/integration/callkit/preset/vue/integration.md +1 -14
- package/resource/integration/chat/preset/android/integration.md +6 -13
- package/resource/integration/chat/preset/flutter/integration.md +1 -8
- package/resource/integration/chat/preset/ios/integration.md +4 -12
- package/resource/integration/chat/preset/react/integration.md +6 -16
- package/resource/integration/chat/preset/vue/integration.md +0 -9
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +1 -11
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +1 -13
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +2 -10
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +3 -8
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -4
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +1 -5
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +2 -7
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +2 -8
- package/resource/integration/roomkit/preset/vue/integration.md +0 -11
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -7
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -9
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -16
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -11
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +178 -200
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +195 -217
- package/resource/knowledge/callkit/faq/android.md +4 -14
- package/resource/knowledge/callkit/faq/common.md +0 -2
- package/resource/knowledge/callkit/faq/error-code.md +2 -4
- package/resource/knowledge/callkit/faq/ios.md +1 -4
- package/resource/knowledge/callkit/preset/android/api.md +0 -6
- package/resource/knowledge/callkit/preset/ios/api.md +0 -4
- package/resource/knowledge/callkit/preset/react/api.md +3 -4
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +3 -4
- package/resource/knowledge/callkit/preset/vue/api.md +3 -4
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +3 -4
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -7
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -6
- package/resource/knowledge/chat/preset/android/features/language.md +0 -8
- package/resource/knowledge/chat/preset/android/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/android/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/android/features/search.md +0 -7
- package/resource/knowledge/chat/preset/android/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/android-view/integration.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +0 -4
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +0 -9
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/flutter/features/language.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/flutter/features/search.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/ios/features/language.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -6
- package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +4 -26
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
- package/resource/knowledge/chat/preset/vue/features/search.md +4 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +2 -3
- package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -1
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +3 -6
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +1 -4
- package/resource/knowledge/livekit/faq/error-code.md +0 -1
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +3 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +3 -3
- package/resource/knowledge/push/api-reference/android.md +0 -1
- package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
- package/resource/knowledge/push/api-reference/react-native.md +3 -5
- package/resource/knowledge/push/api-reference/uni-app.md +3 -5
- package/resource/knowledge/push/api-reference/unity.md +0 -1
- package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
- package/resource/knowledge/push/config/android.md +0 -24
- package/resource/knowledge/push/config/harmonyos.md +0 -1
- package/resource/knowledge/push/config/ios.md +0 -3
- package/resource/knowledge/push/config/react-native.md +0 -29
- package/resource/knowledge/push/config/unity.md +1 -24
- package/resource/knowledge/push/config/unreal-engine.md +1 -24
- package/resource/knowledge/push/integration/android.md +0 -14
- package/resource/knowledge/push/integration/flutter.md +0 -19
- package/resource/knowledge/push/integration/harmonyos.md +0 -2
- package/resource/knowledge/push/integration/ios.md +0 -3
- package/resource/knowledge/push/integration/react-native.md +0 -24
- package/resource/knowledge/push/integration/uni-app.md +1 -11
- package/resource/knowledge/push/integration/unity.md +0 -9
- package/resource/knowledge/push/integration/unreal-engine.md +1 -17
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -6
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -9
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -11
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -8
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -5
- package/resource/knowledge/roomkit/preset/android/integration.md +0 -4
- package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -13
- package/resource/knowledge/roomkit/preset/ios/integration.md +0 -6
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -16
- package/resource/knowledge/rtcengine/web/api.md +1 -8
- package/resource/knowledge/rtcengine/web/faq.md +3 -5
- package/resource/knowledge/rtcengine/web/how_to_integrated_web_sdk.md +0 -6
- package/resource/knowledge/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/21-advanced-auto-play-policy.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/27-advanced-small-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -3
- package/resource/knowledge/rtcengine/web/plugin/34-advanced-proxy.md +2 -4
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
- package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -2
- package/resource/knowledge/trtc/android/TRTCCloud.md +8 -56
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1 -18
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/android/TXDeviceManager.md +0 -1
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +7 -59
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1 -19
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +6 -7
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +9 -60
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1 -19
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +0 -13
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/server.js +1 -1
- package/tools/common/search_trtc_knowledge.js +2 -0
- package/tools/definitions/search_trtc_knowledge_def.js +1 -0
- package/utils/report-cls-client.js +3 -3
- package/utils/report-es-client.js +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -230
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -797
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -325
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -325
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
## Component Overview
|
|
2
2
|
|
|
3
3
|
MessageInput is a message input component that enables users to create and send messages with a full range of editing options. It supports various message types, including text, images, videos, files, and voice messages. The component also includes features such as emoji selection and offers flexible styling and customization options.
|
|
4
|
-
| <strong>Message Input Interface</strong> | <strong>Emoji Picker</strong> |
|
|
5
|
-
| --- | --- |
|
|
6
|
-
| | |
|
|
7
4
|
|
|
8
5
|
## Component Integration
|
|
9
6
|
|
|
@@ -49,6 +46,3 @@ MessageInput(
|
|
|
49
46
|
```
|
|
50
47
|
|
|
51
48
|
Examples of different configurations:
|
|
52
|
-
| <strong>Default Input Box</strong> | <strong>Input Box with Audio Recording Hidden</strong> | <strong>Input Box with All Features Hidden</strong> |
|
|
53
|
-
| --- | --- | --- |
|
|
54
|
-
| | | |
|
|
@@ -7,10 +7,6 @@ MessageList is a Flutter component designed for displaying and managing chat mes
|
|
|
7
7
|
|
|
8
8
|
- Extensive customization: configure bubble color, corner radius, font, and add custom actions.
|
|
9
9
|
|
|
10
|
-
| <strong>Chat Message List</strong> | <strong>Message Long-Press Menu</strong> |
|
|
11
|
-
| --- | --- |
|
|
12
|
-
| | |
|
|
13
|
-
|
|
14
10
|
MessageList is available as part of TUIKit Flutter. To integrate MessageList, add TUIKit Flutter to your project. For detailed setup instructions, refer to the [TUIKit Flutter documentation](https://www.tencentcloud.com/document/product/1047/77489).
|
|
15
11
|
|
|
16
12
|
## Component Structure
|
|
@@ -148,10 +144,6 @@ MessageList(
|
|
|
148
144
|
```
|
|
149
145
|
|
|
150
146
|
> **Note:**
|
|
151
|
-
>
|
|
152
147
|
> Local configurations override global configuration settings.
|
|
153
148
|
>
|
|
154
149
|
|
|
155
|
-
| <strong>Message List Actions</strong><br><strong>(Default Options)</strong> | <strong>Message List Actions</strong><br><strong>(Copy Option Hidden)</strong> | <strong>Message List Actions</strong><br><strong>(Share Option Added)</strong> |
|
|
156
|
-
| --- | --- | --- |
|
|
157
|
-
| | | |
|
|
@@ -3,14 +3,9 @@
|
|
|
3
3
|
The Search component provides a full-featured search experience, including a search bar, results display, and seamless page navigation. It supports searching for users, groups, and messages, and offers extensive interactive Webhook integration for custom workflows.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Search is available in the Pro edition and Enterprise edition. To use Search function, you need to purchase either the Pro or Enterprise package. For details, see [Billing Information](https://trtc.io/document/67650).
|
|
8
7
|
>
|
|
9
8
|
|
|
10
|
-
| <strong>Search Entry</strong> | <strong>Search Results</strong> |
|
|
11
|
-
| --- | --- |
|
|
12
|
-
| | |
|
|
13
|
-
|
|
14
9
|
## Component Integration
|
|
15
10
|
|
|
16
11
|
Search is included in TUIKit Flutter. To use the Search component, integrate TUIKit Flutter into your project and complete the login flow. For detailed integration steps, refer to the [TUIKit Flutter](https://www.tencentcloud.com/document/product/1047/77489) documentation.
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
TUIKit Flutter offers flexible appearance customization with support for Light, Dark, and System theme modes, along with customizable primary colors. A simple configuration enables theme switching and brand color application throughout your app.
|
|
2
2
|
|
|
3
3
|
For example, in the message list, you can see how different theme modes and primary colors affect the UI:
|
|
4
|
-
| <strong>Light + Default Color</strong> | <strong>Light + Orange</strong> | <strong>Dark + Default Color</strong> | <strong>Dark + Green Theme</strong> |
|
|
5
|
-
| --- | --- | --- | --- |
|
|
6
|
-
| | | | |
|
|
7
4
|
|
|
8
5
|
## Core Features
|
|
9
6
|
|
|
@@ -62,7 +59,6 @@ This section covers how to integrate and apply theme and color customization in
|
|
|
62
59
|
|
|
63
60
|
### Project Setup
|
|
64
61
|
|
|
65
|
-
Wrap your app's entry point with `ComponentTheme` and configure `MaterialApp` as shown below. For implementation details, see the [demo](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/chat/demo/lib/main.dart):
|
|
66
62
|
``` java
|
|
67
63
|
@override
|
|
68
64
|
Widget build(BuildContext context) {
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
ChatSetting is a set of chat settings components built with SwiftUI. It includes two main components: C2CChatSetting (C2C Chat Settings) and GroupChatSetting (Group Chat Settings).
|
|
4
4
|
|
|
5
5
|
These components offer robust chat session management features, such as user information management, permission controls, group management, and other essential capabilities.
|
|
6
|
-
| <strong>C2C Chat Settings Interface</strong> | <strong>Group Chat Settings Interface</strong> |
|
|
7
|
-
| --- | --- |
|
|
8
|
-
| | |
|
|
9
6
|
|
|
10
7
|
## Component Integration
|
|
11
8
|
|
|
@@ -49,7 +46,6 @@ ChatSetting contains two main components: C2CChatSetting (C2C Chat Settings) and
|
|
|
49
46
|
|
|
50
47
|
## Basic Usage
|
|
51
48
|
|
|
52
|
-
To display the C2C Chat Settings page, initialize C2CChatSetting as shown below:
|
|
53
49
|
``` swift
|
|
54
50
|
import AtomicX
|
|
55
51
|
import SwiftUI
|
|
@@ -71,7 +67,6 @@ struct C2CSettingView: View {
|
|
|
71
67
|
}
|
|
72
68
|
```
|
|
73
69
|
|
|
74
|
-
To display the Group Chat Settings page, initialize GroupChatSetting as shown below:
|
|
75
70
|
``` swift
|
|
76
71
|
import AtomicX
|
|
77
72
|
import SwiftUI
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
## Component Overview
|
|
2
2
|
|
|
3
3
|
ContactList is a SwiftUI component that provides a complete contact management interface. It supports displaying contacts, handling friend requests, managing group lists, blacklist management, and offers a variety of interactive webhook interfaces.
|
|
4
|
-
| <strong>Contact List</strong> | <strong>Group List</strong> | <strong>Friend Request List</strong> |
|
|
5
|
-
| --- | --- | --- |
|
|
6
|
-
| | | |
|
|
7
4
|
|
|
8
5
|
## Component Integration
|
|
9
6
|
|
|
@@ -18,8 +15,6 @@ The `ContactList` component is included in TUIKit SwiftUI. To use `ContactList`,
|
|
|
18
15
|
| <code>onContactClick: ((AZOrderedListItem) -> Void)?</code> | Webhook triggered when a contact is clicked. Optional. | |
|
|
19
16
|
| <code>onGroupClick: ((AZOrderedListItem) -> Void)?</code> | Webhook triggered when a group is clicked. Optional. | |
|
|
20
17
|
|
|
21
|
-
The top section of `ContactList` includes entry cells for subviews such as friend requests, group requests, group list, and blacklist. The lower section displays the contact list, as shown below:
|
|
22
|
-
|
|
23
18
|
`ContactList` includes built-in navigation for subpages. When you tap entries such as friend requests, group requests, group list, or blacklist, the corresponding subpage opens automatically as a full-screen modal (fullScreenCover). No manual navigation handling is required.
|
|
24
19
|
|
|
25
20
|
If you want to use subpages independently (such as the friend request list or group list), each subpage provides its own initializer, as described below:
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
## Component Overview
|
|
2
2
|
|
|
3
3
|
ConversationList is a SwiftUI component for displaying and managing user chat conversations. It offers a full set of conversation list features, including conversation display and interactive actions.
|
|
4
|
-
| <strong>Conversation List</strong> | <strong>Conversation Actions</strong> |
|
|
5
|
-
| --- | --- |
|
|
6
|
-
| | |
|
|
7
4
|
|
|
8
5
|
## Component Integration
|
|
9
6
|
|
|
@@ -123,11 +120,7 @@ ConversationList(
|
|
|
123
120
|
```
|
|
124
121
|
|
|
125
122
|
> **Note:**
|
|
126
|
-
>
|
|
127
123
|
> Local configuration takes precedence over global configuration.
|
|
128
124
|
>
|
|
129
125
|
|
|
130
126
|
The following images show the customization effects:
|
|
131
|
-
| <strong>Conversation Actions</strong><br><strong>(Default Options)</strong> | <strong>Conversation Actions</strong><br><strong>(Delete Option Hidden)</strong> | <strong>Conversation Actions</strong><br><strong>(Share Option Added)</strong> |
|
|
132
|
-
| --- | --- | --- |
|
|
133
|
-
| | | |
|
|
@@ -4,10 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
This documentation covers how to use these default language packs, customize translation entries, or add new language packs.
|
|
6
6
|
|
|
7
|
-
|**English**|**Arabic**|**Simplified Chinese**|
|
|
8
|
-
|---------|---------|---------|
|
|
9
|
-
||||
|
|
10
|
-
|
|
11
7
|
## Using Built-in Languages
|
|
12
8
|
|
|
13
9
|
If your app only needs to support **English**, **Simplified Chinese**, **Traditional Chinese**, and **Arabic**, follow this section.
|
|
@@ -47,10 +43,9 @@ Resources/strings/ChatLocalizable.bundle/Localizable/
|
|
|
47
43
|
└── ko.lproj/Localizable.strings // Korean translation file; "ko" is the ISO 639-1 language code for Korean
|
|
48
44
|
```
|
|
49
45
|
|
|
50
|
-
|
|
46
|
+
.lproj/Localizable.strings` and provide Korean translations for each entry.
|
|
51
47
|
|
|
52
48
|
> **Note:**
|
|
53
|
-
>
|
|
54
49
|
> 1. For other bundles (such as AlbumPickerLocalizable, VideoRecorderLocalizable, RTCLocalizable, etc.), it's recommended to add `ko.lproj` as well.
|
|
55
50
|
> 2. For the full list of language codes, see ISO 639-1 language codes.
|
|
56
51
|
|
|
@@ -97,8 +92,6 @@ let languageState = LanguageState()
|
|
|
97
92
|
languageState.setLanguage("zh-Hans")
|
|
98
93
|
```
|
|
99
94
|
|
|
100
|
-
Once completed, the interface will display in Korean, as shown below:
|
|
101
|
-
|
|
102
95
|
## Appendix: Language Code Table
|
|
103
96
|
|
|
104
97
|
|Language|Code|Language|Code|
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
## Component Overview
|
|
2
2
|
|
|
3
3
|
MessageInput is a SwiftUI-based message input component that enables users to compose and send a variety of message types, including text, images, videos, files, and voice messages. It features an integrated emoji picker, supports multiple style configurations, and offers extensive customization options.
|
|
4
|
-
| <strong>Message Input Interface</strong> | <strong>Emoji Picker</strong> |
|
|
5
|
-
| --- | --- |
|
|
6
|
-
| | |
|
|
7
4
|
|
|
8
5
|
## Component Integration
|
|
9
6
|
|
|
@@ -64,6 +61,3 @@ MessageInput(
|
|
|
64
61
|
```
|
|
65
62
|
|
|
66
63
|
The following images show different customization effects:
|
|
67
|
-
| <strong>Default Input Box</strong> | <strong>Input Box with Audio Recording Hidden</strong> | <strong>Input Box with All Features Hidden</strong> |
|
|
68
|
-
| --- | --- | --- |
|
|
69
|
-
| | | |
|
|
@@ -7,10 +7,6 @@ MessageList is a SwiftUI-based component designed for displaying and managing ch
|
|
|
7
7
|
|
|
8
8
|
- Highly customizable: Configure styles like bubble color, corner radius, font, and add custom action items.
|
|
9
9
|
|
|
10
|
-
| <strong>Chat Message List</strong> | <strong>Message Long-Press Menu</strong> |
|
|
11
|
-
| --- | --- |
|
|
12
|
-
| | |
|
|
13
|
-
|
|
14
10
|
## Component Integration
|
|
15
11
|
|
|
16
12
|
MessageList is part of TUIKit SwiftUI. To use MessageList, first integrate TUIKit SwiftUI. For detailed integration steps, see the [TUIKit SwiftUI documentation](https://www.tencentcloud.com/document/product/1047/77460).
|
|
@@ -151,11 +147,7 @@ MessageList(
|
|
|
151
147
|
```
|
|
152
148
|
|
|
153
149
|
> **Note:**
|
|
154
|
-
>
|
|
155
150
|
> Local configuration overrides global configuration.
|
|
156
151
|
>
|
|
157
152
|
|
|
158
153
|
The following images show the customization effects:
|
|
159
|
-
| <strong>Message List Actions</strong><br><strong>(Default Options)</strong> | <strong>Message List Actions</strong><br><strong>(Hide Copy Option)</strong> | <strong>Message List Actions</strong><br><strong>(Add Share Option)</strong> |
|
|
160
|
-
| --- | --- | --- |
|
|
161
|
-
| | | |
|
|
@@ -3,14 +3,9 @@
|
|
|
3
3
|
Search is a search component that provides users with a complete set of features, including a search box, search result display, and interface navigation. This component supports user search, group search, and message search, and offers a comprehensive set of interactive webhook interfaces.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Search function is available only in the Pro Edition or Enterprise Edition. You can use this feature after purchasing the Pro Edition or Enterprise Edition package. For details, see [Pricing Information](https://trtc.io/document/67650).
|
|
8
7
|
>
|
|
9
8
|
|
|
10
|
-
| <strong>Search Entry</strong> | <strong>Search Results</strong> |
|
|
11
|
-
| --- | --- |
|
|
12
|
-
| | |
|
|
13
|
-
|
|
14
9
|
## Component Integration
|
|
15
10
|
|
|
16
11
|
The Search component is included in TUIKit SwiftUI. To use the Search component, integrate TUIKit SwiftUI into your project. For detailed integration steps, refer to the [TUIKit SwiftUI](https://www.tencentcloud.com/document/product/1047/77460) documentation and complete the login process.
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
TUIKit offers flexible appearance customization with support for Light, Dark, and System theme modes, along with customizable primary colors. A simple configuration enables theme switching and brand color application throughout your app.
|
|
2
2
|
|
|
3
3
|
For example, in the message list, you can see how different theme modes and primary colors affect the UI:
|
|
4
|
-
| <strong>Light + Default Color</strong> | <strong>Light + Orange</strong> | <strong>Dark + Default Color</strong> | <strong>Dark + Green Theme</strong> |
|
|
5
|
-
| --- | --- | --- | --- |
|
|
6
|
-
| | | | |
|
|
7
4
|
|
|
8
5
|
## Core Capabilities
|
|
9
6
|
|
|
@@ -41,7 +38,6 @@ All theme configuration and queries are handled through a simple set of APIs in
|
|
|
41
38
|
|`clearPrimaryColor()`|None|`Void`|Removes the custom primary color and restores the default blue.|
|
|
42
39
|
|
|
43
40
|
> **Note:**
|
|
44
|
-
>
|
|
45
41
|
> 1. After calling `setThemeMode` or `setPrimaryColor`, the configuration is automatically saved to `UserDefaults`. No manual saving is required. The settings will be loaded automatically when the app restarts.
|
|
46
42
|
> 2. When you update the theme configuration, the cache is cleared automatically to ensure the color scheme updates in real time. No manual cache management is needed.
|
|
47
43
|
> 3. Avoid frequent theme changes when using these APIs (for example, do not call them in a loop).
|
|
@@ -44,7 +44,6 @@ TUIKit is a UI component library built on the Chat SDK. It enables rapid impleme
|
|
|
44
44
|
【Remote CocoaPods Integration】
|
|
45
45
|
|
|
46
46
|
> **Note:**
|
|
47
|
-
>
|
|
48
47
|
> 1. Starting from version 8.5.6870, TUIKit supports Swift components.
|
|
49
48
|
> 2. If you add only `pod 'TUIChat'` in your Podfile without specifying Classic or Minimalist UI, both UI component versions will be integrated by default.
|
|
50
49
|
> 3. **Classic and Minimalist UI cannot be mixed.** When integrating multiple components, select either all Classic UI or all Minimalist UI components. For example, the Classic `TUIChat` component must be used with Classic `TUIConversation` and `TUIContact` components. Similarly, the Minimalist `TUIChat` component must be used with Minimalist `TUIConversation` and `TUIContact` components.
|
|
@@ -347,7 +346,6 @@ pod install
|
|
|
347
346
|
```
|
|
348
347
|
|
|
349
348
|
> **Note:**
|
|
350
|
-
>
|
|
351
349
|
> 1. If you cannot install the latest version of TUIKit, run `pod repo update` to update your local CocoaPods repository, then run `pod update` to update the component library version.
|
|
352
350
|
> 2. If you encounter third-party library version conflicts, see CocoaPods FAQs - Dependency Version Conflicts.
|
|
353
351
|
|
|
@@ -728,7 +726,3 @@ pod install
|
|
|
728
726
|
#### Using Emoji Packs
|
|
729
727
|
|
|
730
728
|
To respect the copyright of emoji designs, the Chat Demo/TUIKit project does not include cutouts of large emoji elements. Please replace them with your own designs or other emoji packs for which you hold the copyright before officially launching for commercial use. **The default smiley face emoji pack shown below is copyrighted by Tencent RTC**, you can upgrade to [Chat Pro Plus Edition and Enterprise Edition](https://console.trtc.io/subscription/buy/chat) to use it for free.
|
|
731
|
-
|
|
732
|
-
## Contact Us
|
|
733
|
-
|
|
734
|
-
If you have any questions or suggestions, feel free to join our [Telegram](https://t.me/tencent_imsdk) or [WhatsApp](https://chat.whatsapp.com/IVa11ZkVmKTEwSWsAzSyik) community, or [contact us](https://trtc.io/contact) for support.
|
|
@@ -72,8 +72,6 @@ By setting the `enableSearch` parameter, you can flexibly control the display of
|
|
|
72
72
|
<ContactList enableSearch={false} />
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
The effect is as shown below.
|
|
76
|
-
|
|
77
75
|
### Custom Contact List Contact Group Configuration
|
|
78
76
|
|
|
79
77
|
`groupConfig` is used for custom group configuration, including title, display sequence, hidden state, etc. The default value is `{}`.
|
|
@@ -111,8 +109,6 @@ function CustomGroupTitlesContactList() {
|
|
|
111
109
|
}
|
|
112
110
|
```
|
|
113
111
|
|
|
114
|
-
The effect is as shown below.
|
|
115
|
-
|
|
116
112
|
【Hide Specific Group】
|
|
117
113
|
``` typescript
|
|
118
114
|
import React from 'react';
|
|
@@ -142,8 +138,6 @@ function HiddenGroupsContactList() {
|
|
|
142
138
|
}
|
|
143
139
|
```
|
|
144
140
|
|
|
145
|
-
The effect is as shown below.
|
|
146
|
-
|
|
147
141
|
### Custom Contact List Sub-Item
|
|
148
142
|
|
|
149
143
|
ContactItem is used for custom rendering component of contact person, with default value as built-in `ContactListItem` component.
|
|
@@ -190,8 +184,6 @@ function ContactListWithSimpleItems() {
|
|
|
190
184
|
}
|
|
191
185
|
```
|
|
192
186
|
|
|
193
|
-
The effect is as shown below.
|
|
194
|
-
|
|
195
187
|
### Custom Contact Person Detail Action Button Switch
|
|
196
188
|
|
|
197
189
|
`showActions` specifies whether to display action buttons. The default value is `true`.
|
|
@@ -220,8 +212,6 @@ function ReadOnlyContactInfo() {
|
|
|
220
212
|
}
|
|
221
213
|
```
|
|
222
214
|
|
|
223
|
-
The effect is as shown below.
|
|
224
|
-
|
|
225
215
|
### Custom Contact Person Detail Empty Status
|
|
226
216
|
|
|
227
217
|
`PlaceholderEmpty` is used for custom empty status display content, default value is `undefined`.
|
|
@@ -255,12 +245,9 @@ function CustomEmptyState() {
|
|
|
255
245
|
}
|
|
256
246
|
```
|
|
257
247
|
|
|
258
|
-
The effect is as shown below.
|
|
259
|
-
|
|
260
248
|
### Custom Contact Person Detail Component
|
|
261
249
|
|
|
262
250
|
> **Note:**
|
|
263
|
-
>
|
|
264
251
|
> - `FriendInfoComponent` for custom friend information component, default value is built-in `FriendInfo` component.
|
|
265
252
|
> - `GroupInfoComponent` for custom group information component, default value is built-in `GroupInfo` component.
|
|
266
253
|
> - `BlacklistInfoComponent` for custom blocklist information component, default value is built-in `BlacklistInfo` component.
|
|
@@ -334,8 +321,6 @@ function CustomFriendInfoDemo() {
|
|
|
334
321
|
}
|
|
335
322
|
```
|
|
336
323
|
|
|
337
|
-
The effect is as shown below.
|
|
338
|
-
|
|
339
324
|
【Custom Group Information Component】
|
|
340
325
|
``` typescript
|
|
341
326
|
import React from 'react';
|
|
@@ -424,8 +409,6 @@ function CustomGroupInfoDemo() {
|
|
|
424
409
|
}
|
|
425
410
|
```
|
|
426
411
|
|
|
427
|
-
The effect is as shown below.
|
|
428
|
-
|
|
429
412
|
【Custom Blocklist Information Component】
|
|
430
413
|
``` typescript
|
|
431
414
|
import React from 'react';
|
|
@@ -499,8 +482,6 @@ function CustomBlacklistInfoDemo() {
|
|
|
499
482
|
}
|
|
500
483
|
```
|
|
501
484
|
|
|
502
|
-
The effect is as shown below.
|
|
503
|
-
|
|
504
485
|
【Custom Friend Request Information Component】
|
|
505
486
|
``` typescript
|
|
506
487
|
import React from 'react';
|
|
@@ -589,8 +570,6 @@ function CustomFriendApplicationInfoDemo() {
|
|
|
589
570
|
}
|
|
590
571
|
```
|
|
591
572
|
|
|
592
|
-
The effect is as shown below.
|
|
593
|
-
|
|
594
573
|
【Custom Group Application Information Component】
|
|
595
574
|
``` typescript
|
|
596
575
|
import React from 'react';
|
|
@@ -684,6 +663,4 @@ function CustomGroupApplicationInfoDemo() {
|
|
|
684
663
|
}
|
|
685
664
|
```
|
|
686
665
|
|
|
687
|
-
The effect is as shown below.
|
|
688
|
-
|
|
689
666
|
##
|
|
@@ -82,17 +82,15 @@ Use the `enablePin`, `enableDelete`, and `enableMute` props to control the visib
|
|
|
82
82
|
``` typescript
|
|
83
83
|
<ConversationActions enablePin={false} />
|
|
84
84
|
```
|
|
85
|
+
|
|
85
86
|
``` typescript
|
|
86
87
|
<ConversationActions enableDelete={false} />
|
|
87
88
|
```
|
|
89
|
+
|
|
88
90
|
``` typescript
|
|
89
91
|
<ConversationActions enableMute={false} />
|
|
90
92
|
```
|
|
91
93
|
|
|
92
|
-
|`enablePin={false}`|`enableDelete={false}`|`enableMute={false}`|
|
|
93
|
-
|---------|---------|---------|
|
|
94
|
-
||||
|
|
95
|
-
|
|
96
94
|
### Event Handling
|
|
97
95
|
|
|
98
96
|
`ConversationActions` provides built-in support for deleting conversations, pinning or unpinning conversations, and enabling or disabling Do Not Disturb. If you need to override the default event handlers, provide your own handler functions. You can also use the `onClick` prop to handle generic click events.
|
|
@@ -157,10 +155,6 @@ const CustomConversationActions = (props: ConversationActionsProps) => {
|
|
|
157
155
|
<ConversationList ConversationActions={CustomConversationActions} />
|
|
158
156
|
```
|
|
159
157
|
|
|
160
|
-
|Before|After|
|
|
161
|
-
|---------|---------|
|
|
162
|
-
|||
|
|
163
|
-
|
|
164
158
|
### UI Customization
|
|
165
159
|
|
|
166
160
|
You can fully customize the conversation action menu using third-party UI elements.
|
|
@@ -210,6 +204,3 @@ function CustomConversationActions(props: ConversationActionsProps) {
|
|
|
210
204
|
<ConversationList ConversationActions={CustomConversationActions} />
|
|
211
205
|
```
|
|
212
206
|
|
|
213
|
-
|Before|After|
|
|
214
|
-
|---------|---------|
|
|
215
|
-
|||
|
|
@@ -4,10 +4,6 @@ The `ConversationList` component provides the main conversation list functionali
|
|
|
4
4
|
|
|
5
5
|
This guide covers basic usage, component customization, flexible composition, and a complete list of component props.
|
|
6
6
|
|
|
7
|
-
|**Conversation List**|**Conversation Actions**|**Conversation Search**|**Create Conversation**|
|
|
8
|
-
|---------|---------|---------|---------|
|
|
9
|
-
|||||
|
|
10
|
-
|
|
11
7
|
## Component Structure
|
|
12
8
|
|
|
13
9
|
The `ConversationList` component includes the following:
|
|
@@ -46,17 +42,15 @@ Control the display of conversation search, conversation creation, and conversat
|
|
|
46
42
|
``` typescript
|
|
47
43
|
<ConversationList enableSearch={false} />
|
|
48
44
|
```
|
|
45
|
+
|
|
49
46
|
``` typescript
|
|
50
47
|
<ConversationList enableCreate={false} />
|
|
51
48
|
```
|
|
49
|
+
|
|
52
50
|
``` typescript
|
|
53
51
|
<ConversationList enableActions={false} />
|
|
54
52
|
```
|
|
55
53
|
|
|
56
|
-
|`enableSearch={false}`|`enableCreate={false}`|`enableActions={false}`|
|
|
57
|
-
|---------|---------|---------|
|
|
58
|
-
||||
|
|
59
|
-
|
|
60
54
|
### Data Filtering and Sorting
|
|
61
55
|
|
|
62
56
|
The `ConversationList` component provides `filterConversation` and `sortConversation` properties to filter and sort conversation list data.
|
|
@@ -103,7 +97,7 @@ By using the `filter` and `sort` properties, you can efficiently filter and sort
|
|
|
103
97
|
|
|
104
98
|
Use actionsConfig to control the basic functionality of `ConversationActions`.
|
|
105
99
|
|
|
106
|
-
For additional customization
|
|
100
|
+
For additional customization.
|
|
107
101
|
``` typescript
|
|
108
102
|
import { ConversationList } from '@tencentcloud/chat-uikit-react';
|
|
109
103
|
import type { ConversationInfo } from '@tencentcloud/chat-uikit-react';
|
|
@@ -122,10 +116,6 @@ import type { ConversationInfo } from '@tencentcloud/chat-uikit-react';
|
|
|
122
116
|
/>
|
|
123
117
|
```
|
|
124
118
|
|
|
125
|
-
|`enablePin: false`|`enableDelete: false`|`enableMute: false`|`customConversationActions`|
|
|
126
|
-
|---------|---------|---------|---------|
|
|
127
|
-
|||||
|
|
128
|
-
|
|
129
119
|
### Custom Placeholder
|
|
130
120
|
|
|
131
121
|
Customize the list display for different states by passing `PlaceholderEmptyList`, `PlaceholderLoading`, and `PlaceholderLoadError`.
|
|
@@ -176,10 +166,6 @@ const CustomConversationListHeader = (props) => {
|
|
|
176
166
|
|
|
177
167
|
The following example implements conversation grouping, categorizing by All, Unread, C2C, and Group. Clicking each group button applies a different filter.
|
|
178
168
|
|
|
179
|
-
|**Before**|**After**|
|
|
180
|
-
|---------|---------|
|
|
181
|
-
|||
|
|
182
|
-
|
|
183
169
|
``` typescript
|
|
184
170
|
import { useState } from 'react';
|
|
185
171
|
import { ConversationList, UIKitProvider, ConversationInfo } from '@tencentcloud/chat-uikit-react';
|
|
@@ -216,6 +202,7 @@ const App = () => {
|
|
|
216
202
|
);
|
|
217
203
|
};
|
|
218
204
|
```
|
|
205
|
+
|
|
219
206
|
``` scss
|
|
220
207
|
.conversation-group-wrapper {
|
|
221
208
|
display: flex;
|
|
@@ -264,8 +251,6 @@ By default, it displays the current conversation list data (`filteredAndSortedCo
|
|
|
264
251
|
|
|
265
252
|
#### Basic Customization
|
|
266
253
|
|
|
267
|
-
The `List` component manages different UI states as shown below. State transitions are handled internally within `ConversationList`.
|
|
268
|
-
|
|
269
254
|
You can also control the component state by passing custom `empty`, `loading`, or `error` props.
|
|
270
255
|
``` typescript
|
|
271
256
|
import { ConversationList, ConversationListContent } from '@tencentcloud/chat-uikit-react';
|
|
@@ -277,27 +262,20 @@ const CustomConversationListContent = (props) => {
|
|
|
277
262
|
<ConversationList List={CustomConversationListContent} />
|
|
278
263
|
```
|
|
279
264
|
|
|
280
|
-
|`default`|`empty={true}`|`loading={true}`|`error={true}`|
|
|
281
|
-
|---------|---------|---------|---------|
|
|
282
|
-
|||||
|
|
283
|
-
|
|
284
265
|
### Custom ConversationPreview
|
|
285
266
|
|
|
286
|
-
For details, see the ConversationPreview section.
|
|
287
267
|
``` typescript
|
|
288
268
|
<ConversationList ConversationPreview={CustomConversationPreview} />
|
|
289
269
|
```
|
|
290
270
|
|
|
291
271
|
### Custom ConversationActions
|
|
292
272
|
|
|
293
|
-
For details, see the ConversationActions section.
|
|
294
273
|
``` typescript
|
|
295
274
|
<ConversationList ConversationActions={CustomConversationActions} />
|
|
296
275
|
```
|
|
297
276
|
|
|
298
277
|
### Custom ConversationSearch
|
|
299
278
|
|
|
300
|
-
For details, see the ConversationSearch section.
|
|
301
279
|
``` typescript
|
|
302
280
|
<ConversationList ConversationSearch={CustomConversationSearch} />
|
|
303
281
|
```
|
|
@@ -27,8 +27,6 @@ Meanwhile, you can also use the `onConversationSelect` function to define select
|
|
|
27
27
|
|
|
28
28
|
### Discord-Like Style
|
|
29
29
|
|
|
30
|
-
Discord is a popular chat application, similar to Skype or Telegram. The message content in Discord is as shown below:
|
|
31
|
-
|
|
32
30
|
By customizing the `ConversationPreview` layout, features, and style, we can quickly achieve a Discord-like effect.
|
|
33
31
|
|
|
34
32
|
【React】
|
|
@@ -94,8 +92,4 @@ const App = () => {
|
|
|
94
92
|
|
|
95
93
|
`ConversationListPreview` effect as follows after customization:
|
|
96
94
|
|
|
97
|
-
|**Before Modification**|**Modified**|
|
|
98
|
-
|---------|---------|
|
|
99
|
-
|||
|
|
100
|
-
|
|
101
95
|
###
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
Search is a complete search solution with a full set of components, including search bar, result display, advanced search, and other features. It is suitable for user, group, and message search in instant messaging, online meeting, and online education scenarios.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Note: This feature belongs to VAS. You need to purchase cloud search plugin. Please click [purchase](https://console.trtc.io/chat/plugin/TUICloudSearch).
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -167,6 +167,7 @@ const handleClick = () => {
|
|
|
167
167
|
</style>
|
|
168
168
|
|
|
169
169
|
```
|
|
170
|
+
|
|
170
171
|
``` typescript
|
|
171
172
|
<template>
|
|
172
173
|
<ContactList :ContactItem="CustomContactItem" />
|
|
@@ -177,9 +178,6 @@ import { ContactList } from '@tencentcloud/chat-uikit-vue3';
|
|
|
177
178
|
import CustomContactItem from './CustomContactItem.vue';
|
|
178
179
|
</script>
|
|
179
180
|
```
|
|
180
|
-
| Before | After |
|
|
181
|
-
| --- | --- |
|
|
182
|
-
| | |
|
|
183
181
|
|
|
184
182
|
### Custom Contact Detail Action Toggle
|
|
185
183
|
|
|
@@ -191,9 +189,6 @@ Use the `showActions` prop to control whether action buttons are shown on the co
|
|
|
191
189
|
/>
|
|
192
190
|
</template>
|
|
193
191
|
```
|
|
194
|
-
| Before | After |
|
|
195
|
-
| --- | --- |
|
|
196
|
-
| | |
|
|
197
192
|
|
|
198
193
|
### Custom Contact Detail Empty State
|
|
199
194
|
|
|
@@ -205,6 +200,7 @@ When no contact is selected, you can customize the empty state component.
|
|
|
205
200
|
</div>
|
|
206
201
|
</template>
|
|
207
202
|
```
|
|
203
|
+
|
|
208
204
|
``` typescript
|
|
209
205
|
<template>
|
|
210
206
|
<ContactInfo
|
|
@@ -259,6 +255,7 @@ defineProps<{
|
|
|
259
255
|
</style>
|
|
260
256
|
|
|
261
257
|
```
|
|
258
|
+
|
|
262
259
|
``` typescript
|
|
263
260
|
<template>
|
|
264
261
|
<ContactInfo
|
|
@@ -272,6 +269,3 @@ import type { FriendInfoProps, GroupInfoProps } from '@tencentcloud/chat-uikit-v
|
|
|
272
269
|
import CustomFriendInfo from './CustomFriendInfo.vue';
|
|
273
270
|
</script>
|
|
274
271
|
```
|
|
275
|
-
| Before | After |
|
|
276
|
-
| --- | --- |
|
|
277
|
-
| | |
|
|
@@ -131,9 +131,6 @@ Use `enablePin`, `enableDelete`, `enableMute`, and `enableMarkUnread` to control
|
|
|
131
131
|
<ConversationActions :enableMarkUnread="false" :conversation="conversation" />
|
|
132
132
|
</template>
|
|
133
133
|
```
|
|
134
|
-
| <code>enablePin: false</code> | <code>enableDelete: false</code> | <code>enableMute: false</code> | enableMarkUnread="false" |
|
|
135
|
-
| --- | --- | --- | --- |
|
|
136
|
-
| | | | |
|
|
137
134
|
|
|
138
135
|
### Event handlers
|
|
139
136
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
The `ConversationList` component renders the conversation list and supports search, creation, pinning, deletion, and other conversation actions.
|
|
4
4
|
|
|
5
|
-
|**Conversation List**|**Conversation Actions**|**Create Conversation**|
|
|
6
|
-
|---------|---------|---------|
|
|
7
|
-
||||
|
|
8
|
-
|
|
9
5
|
## Component Structure
|
|
10
6
|
|
|
11
7
|
The `ConversationList` component includes the following:
|
|
@@ -43,15 +39,14 @@ Use `enableSearch`, `enableCreate`, and `enableActions` to control whether conve
|
|
|
43
39
|
``` typescript
|
|
44
40
|
<ConversationList :enableSearch="false" />
|
|
45
41
|
```
|
|
42
|
+
|
|
46
43
|
``` typescript
|
|
47
44
|
<ConversationList :enableCreate="false" />
|
|
48
45
|
```
|
|
46
|
+
|
|
49
47
|
``` typescript
|
|
50
48
|
<ConversationList :enableActions="false" />
|
|
51
49
|
```
|
|
52
|
-
| <code>enableSearch="false"</code> | <code>enableCreate="false"</code> | <code>enableActions="false"</code> |
|
|
53
|
-
| --- | --- | --- |
|
|
54
|
-
| | | |
|
|
55
50
|
|
|
56
51
|
### Data Filtering and Sorting
|
|
57
52
|
|
|
@@ -126,9 +121,6 @@ import { UIKitProvider, ConversationList } from '@tencentcloud/chat-uikit-vue3';
|
|
|
126
121
|
import type { ConversationInfo } from '@tencentcloud/chat-uikit-vue3';
|
|
127
122
|
</script>
|
|
128
123
|
```
|
|
129
|
-
| <code>enablePin: false</code> | <code>enableDelete: false</code> | <code>enableMute: false</code> | <code>customConversationActions</code> |
|
|
130
|
-
| --- | --- | --- | --- |
|
|
131
|
-
| | | | |
|
|
132
124
|
|
|
133
125
|
### Custom Placeholder
|
|
134
126
|
|
|
@@ -300,9 +292,6 @@ const handleFilterClick = (filterType: FilterType) => {
|
|
|
300
292
|
</style>
|
|
301
293
|
|
|
302
294
|
```
|
|
303
|
-
| **Before** | **After** |
|
|
304
|
-
| --- | --- |
|
|
305
|
-
| | |
|
|
306
295
|
|
|
307
296
|
## Props
|
|
308
297
|
|