@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1
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/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -12
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +6 -5
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.js.map +0 -1
- package/tools/common/get_usersig.js.map +0 -1
- package/tools/common/present_framework_choice.js.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -40
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -1,282 +0,0 @@
|
|
|
1
|
-
## 组件概述
|
|
2
|
-
|
|
3
|
-
Search 是一个功能完整的搜索解决方案,包含了搜索框、搜索结果展示、高级搜索等功能的完整组件集合。适用于即时通讯、在线会议、在线教育等场景的用户、群组、消息搜索。
|
|
4
|
-
|
|
5
|
-
> **说明:**
|
|
6
|
-
>
|
|
7
|
-
|
|
8
|
-
> 此功能属于增值服务,需要您购买云端搜索插件,请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
|
|
9
|
-
>
|
|
10
|
-
|
|
11
|
-
## 组件架构
|
|
12
|
-
``` bash
|
|
13
|
-
Search (主组件)
|
|
14
|
-
├── SearchBar # 搜索框组件
|
|
15
|
-
├── SearchResults # 搜索结果组件
|
|
16
|
-
├── SearchAdvanced # 高级搜索组件
|
|
17
|
-
└── SearchResultsItem # 搜索结果项组件
|
|
18
|
-
├── User # 用户结果项
|
|
19
|
-
├── Group # 群组结果项
|
|
20
|
-
├── Message # 消息结果项
|
|
21
|
-
└── Conversation # 会话结果项
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## 搜索模式
|
|
25
|
-
| **迷你模式** | **标准模式** | **嵌入式模式** |
|
|
26
|
-
| --- | --- | --- |
|
|
27
|
-
| - 适用于侧边栏或小容器<br>- 显示有限结果数量<br>- 支持展开查看更多 | - 适用于全屏搜索界面<br>- 完整功能展示<br>- 支持高级搜索 | - 适用于聊天界面<br>- 专注消息搜索<br>- 优化的布局 |
|
|
28
|
-
| | | |
|
|
29
|
-
|
|
30
|
-
## Props
|
|
31
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
32
|
-
| --- | --- | --- | --- |
|
|
33
|
-
| variant | `VariantType` | `VariantType.MINI` | 搜索模式:`mini`(迷你)、`standard`(标准)、`embedded`(嵌入式) |
|
|
34
|
-
| SearchBar | `React.ComponentType<SearchBarProps>` | `DefaultSearchBar` | 自定义搜索框组件 |
|
|
35
|
-
| SearchResults | `React.ComponentType<SearchResultsProps>` | `DefaultSearchResults` | 自定义搜索结果组件 |
|
|
36
|
-
| SearchAdvanced | `React.ComponentType<SearchAdvancedProps>` | `DefaultSearchAdvanced` | 自定义高级搜索组件 |
|
|
37
|
-
| SearchResultsPresearch | `React.ComponentType` | - | 搜索前占位符组件 |
|
|
38
|
-
| SearchResultsLoading | `React.ComponentType` | - | 加载中占位符组件 |
|
|
39
|
-
| SearchResultsEmpty | `React.ComponentType` | - | 空结果占位符组件 |
|
|
40
|
-
| SearchResultItem | `React.ComponentType<ResultItemProps>` | - | 自定义搜索结果项组件 |
|
|
41
|
-
| debounceTime | `number` | `300` | 搜索防抖时间(毫秒) |
|
|
42
|
-
| autoFocus | `boolean` | `false` | 是否自动聚焦搜索框 |
|
|
43
|
-
| className | `string` | - | 自定义样式类名 |
|
|
44
|
-
| style | `React.CSSProperties` | - | 自定义样式 |
|
|
45
|
-
| onKeywordChange | `(keyword: string) => void` | - | 搜索关键词变化回调 |
|
|
46
|
-
| onSearchComplete | `(results: Map<SearchType, SearchResult>) => void` | - | 搜索完成回调 |
|
|
47
|
-
| onResultItemClick | `(data: SearchResultItem, type: SearchType) => void` | - | 搜索结果点击回调 |
|
|
48
|
-
| onError | `(error: Error) => void` | - | 搜索错误回调 |
|
|
49
|
-
|
|
50
|
-
## 基础使用
|
|
51
|
-
``` typescript
|
|
52
|
-
import { Search, VariantType } from '@tencentcloud/chat-uikit-react';
|
|
53
|
-
|
|
54
|
-
function App() {
|
|
55
|
-
return (
|
|
56
|
-
<Search
|
|
57
|
-
variant={VariantType.STANDARD}
|
|
58
|
-
onResultItemClick={(data, type) => {
|
|
59
|
-
console.log('搜索结果点击:', data, type);
|
|
60
|
-
}}
|
|
61
|
-
/>
|
|
62
|
-
);
|
|
63
|
-
}
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## 自定义能力
|
|
67
|
-
|
|
68
|
-
`Search` 为用户自定义提供了丰富且多维度的 Props 接口,允许用户自定义功能、UI、模块等。
|
|
69
|
-
|
|
70
|
-
`Search` 组件提供了多个可替换的子组件,允许用户自定义 `SearchBar`, `SearchResults`, `SearchAdvanced`, `SearchResultItem`, `SearchResultsPresearch`, `SearchResultsLoading`, `SearchResultsEmpty`, 等。同时,用户还可以利用默认子组件进行二次开发定制。
|
|
71
|
-
|
|
72
|
-
【自定义 SearchBar】
|
|
73
|
-
|
|
74
|
-
**Props**
|
|
75
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
76
|
-
| --- | --- | --- | --- |
|
|
77
|
-
| data | `SearchResultItem` | - | 搜索结果数据 |
|
|
78
|
-
| type | `SearchType` | - | 搜索结果类型 |
|
|
79
|
-
| keyword | `string` | - | 搜索关键词 |
|
|
80
|
-
| onClick | `(data: SearchResultItem, type: SearchType) => void` | - | 点击回调 |
|
|
81
|
-
| className | `string` | - | 自定义样式类名 |
|
|
82
|
-
|
|
83
|
-
**示例**
|
|
84
|
-
``` typescript
|
|
85
|
-
const CustomSearchBar = ({ value, onChange, onClear, placeholder }) => (
|
|
86
|
-
<div className="custom-search-bar">
|
|
87
|
-
<input
|
|
88
|
-
type="text"
|
|
89
|
-
value={value}
|
|
90
|
-
onChange={onChange}
|
|
91
|
-
placeholder={placeholder}
|
|
92
|
-
/>
|
|
93
|
-
{value && <button onClick={onClear}>清除</button>}
|
|
94
|
-
</div>
|
|
95
|
-
);
|
|
96
|
-
|
|
97
|
-
<Search SearchBar={CustomSearchBar} />
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
【自定义 SearchResults】
|
|
101
|
-
|
|
102
|
-
**Props**
|
|
103
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
104
|
-
| --- | --- | --- | --- |
|
|
105
|
-
| results | `Map<SearchType, SearchResult>` | - | 搜索结果数据 |
|
|
106
|
-
| isLoading | `boolean` | - | 是否正在加载 |
|
|
107
|
-
| error | `Error \\| null` | - | 错误信息 |
|
|
108
|
-
| keyword | `string` | - | 搜索关键词 |
|
|
109
|
-
| typeLabels | `Record<SearchType, string>` | - | 搜索类型标签 |
|
|
110
|
-
| onLoadMore | `(type: SearchType) => void` | - | 加载更多回调 |
|
|
111
|
-
| onResultItemClick | `(data: SearchResultItem, type: SearchType) => void` | - | 结果项点击回调 |
|
|
112
|
-
| SearchResultsLoading | `React.ComponentType` | `Loading` | 自定义加载组件 |
|
|
113
|
-
| SearchResultsPresearch | `React.ComponentType` | - | 搜索前占位符组件 |
|
|
114
|
-
| SearchResultsEmpty | `React.ComponentType` | `EmptyResult` | 空结果占位符组件 |
|
|
115
|
-
| SearchResultItem | `React.ComponentType<ResultItemProps>` | `DefaultSearchResultsItem` | 自定义结果项组件 |
|
|
116
|
-
| variant | `VariantType` | `VariantType.STANDARD` | 显示模式 |
|
|
117
|
-
| searchType | `SearchType \\| 'all'` | `'all'` | 当前搜索类型 |
|
|
118
|
-
|
|
119
|
-
**示例**
|
|
120
|
-
``` typescript
|
|
121
|
-
const CustomSearchResults = ({ results, keyword, onResultItemClick }) => (
|
|
122
|
-
<div className="custom-results">
|
|
123
|
-
{Array.from(results.entries()).map(([type, result]) => (
|
|
124
|
-
<div key={type}>
|
|
125
|
-
<h3>{type}</h3>
|
|
126
|
-
{result.resultList.map((item, index) => (
|
|
127
|
-
<div key={index} onClick={() => onResultItemClick(item, type)}>
|
|
128
|
-
{/* 自定义结果项 */}
|
|
129
|
-
</div>
|
|
130
|
-
))}
|
|
131
|
-
</div>
|
|
132
|
-
))}
|
|
133
|
-
</div>
|
|
134
|
-
);
|
|
135
|
-
|
|
136
|
-
<Search SearchResults={CustomSearchResults} />
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
【自定义 SearchAdvanced】
|
|
140
|
-
|
|
141
|
-
**Props**
|
|
142
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
143
|
-
| --- | --- | --- | --- |
|
|
144
|
-
| variant | `VariantType` | - | 显示模式 |
|
|
145
|
-
| searchType | `SearchTabType` | - | 当前搜索类型 |
|
|
146
|
-
| advancedParams | `Map<SearchType, SearchParamsMap[SearchType]>` | - | 高级搜索参数 |
|
|
147
|
-
| onAdvancedParamsChange | `(type: SearchType, params: SearchParamsMap[SearchType]) => void` | - | 参数变化回调 |
|
|
148
|
-
|
|
149
|
-
**示例**
|
|
150
|
-
``` typescript
|
|
151
|
-
const CustomSearchAdvanced = ({ variant, searchType, advancedParams, onAdvancedParamsChange }) => (
|
|
152
|
-
<div className="custom-advanced">
|
|
153
|
-
{/* 自定义高级搜索功能 */}
|
|
154
|
-
</div>
|
|
155
|
-
);
|
|
156
|
-
|
|
157
|
-
<Search SearchAdvanced={CustomSearchAdvanced} />
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
【自定义 SearchResultItem】
|
|
161
|
-
|
|
162
|
-
**Props**
|
|
163
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
164
|
-
| --- | --- | --- | --- |
|
|
165
|
-
| data | `SearchResultItem` | - | 搜索结果数据 |
|
|
166
|
-
| type | `SearchType` | - | 搜索结果类型 |
|
|
167
|
-
| keyword | `string` | - | 搜索关键词 |
|
|
168
|
-
| onClick | `(data: SearchResultItem, type: SearchType) => void` | - | 点击回调 |
|
|
169
|
-
| className | `string` | - | 自定义样式类名 |
|
|
170
|
-
|
|
171
|
-
**示例**
|
|
172
|
-
``` typescript
|
|
173
|
-
const CustomSearchItem = ({ data, type, keyword, onClick }) => (
|
|
174
|
-
<div className="custom-item">
|
|
175
|
-
{type === SearchType.MESSAGE && (
|
|
176
|
-
<Conversation
|
|
177
|
-
data={data}
|
|
178
|
-
keyword={keyword}
|
|
179
|
-
onClick={onClick}
|
|
180
|
-
/>
|
|
181
|
-
)}
|
|
182
|
-
{type === SearchType.USER && (
|
|
183
|
-
<User
|
|
184
|
-
data={data}
|
|
185
|
-
keyword={keyword}
|
|
186
|
-
onClick={onClick}
|
|
187
|
-
/>
|
|
188
|
-
)}
|
|
189
|
-
{type === SearchType.GROUP && (
|
|
190
|
-
<Group
|
|
191
|
-
data={data}
|
|
192
|
-
keyword={keyword}
|
|
193
|
-
onClick={onClick}
|
|
194
|
-
/>
|
|
195
|
-
)}
|
|
196
|
-
{type === SearchType.CHAT_MESSAGE && (
|
|
197
|
-
<Message
|
|
198
|
-
data={data}
|
|
199
|
-
keyword={keyword}
|
|
200
|
-
onClick={onClick}
|
|
201
|
-
/>
|
|
202
|
-
)}
|
|
203
|
-
</div>
|
|
204
|
-
);
|
|
205
|
-
|
|
206
|
-
<Search SearchResultItem={CustomSearchItem} />
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
【自定义占位组件】
|
|
210
|
-
|
|
211
|
-
**Props**
|
|
212
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
213
|
-
| --- | --- | --- | --- |
|
|
214
|
-
| SearchResultsPresearch | `React.ComponentType` | - | 搜索前占位符组件 |
|
|
215
|
-
| SearchResultsLoading | `React.ComponentType` | - | 加载中占位符组件 |
|
|
216
|
-
| SearchResultsEmpty | `React.ComponentType` | - | 空结果占位符组件 |
|
|
217
|
-
|
|
218
|
-
**示例**
|
|
219
|
-
``` typescript
|
|
220
|
-
<Search
|
|
221
|
-
SearchResultsPresearch={() => <div>输入关键词开始搜索</div>}
|
|
222
|
-
SearchResultsLoading={() => <div>搜索中...</div>}
|
|
223
|
-
SearchResultsEmpty={() => <div>未找到相关结果</div>}
|
|
224
|
-
/>
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
## SearchState
|
|
228
|
-
|
|
229
|
-
SearchState 是基于 Zustand 的搜索状态管理钩子,为 Search 组件提供完整的状态管理能力。它支持多种搜索模式(标准模式、嵌入式模式),管理搜索关键词、搜索结果、加载状态、错误处理等功能。如果自定义组件能力不能支持您的业务,可以使用 SearchState 实现您的需求。
|
|
230
|
-
|
|
231
|
-
#### 数据
|
|
232
|
-
| 属性名 | 类型 | 说明 |
|
|
233
|
-
| --- | --- | --- |
|
|
234
|
-
| keyword | `string` | 当前搜索关键词 |
|
|
235
|
-
| results | `Map<SearchType, SearchResult<SearchType>>` | 搜索结果集合 |
|
|
236
|
-
| isLoading | `boolean` | 是否正在搜索 |
|
|
237
|
-
| error | `Error \\| null` | 搜索错误信息 |
|
|
238
|
-
| searchAdvancedParams | `Map<ISearchType, SearchParamsMap[SearchType]>` | 高级搜索参数 |
|
|
239
|
-
| selectedSearchType | `SearchType \\| 'all'` | 当前选中的搜索类型 |
|
|
240
|
-
|
|
241
|
-
#### 操作方法
|
|
242
|
-
| 方法名 | 类型 | 说明 |
|
|
243
|
-
| --- | --- | --- |
|
|
244
|
-
| setKeyword | `(k: string) => void` | 设置搜索关键词 |
|
|
245
|
-
| loadMore | `(type?: SearchType) => Promise<void>` | 加载更多搜索结果 |
|
|
246
|
-
| setSelectedType | `(type: SearchType \\| 'all') => void` | 设置搜索类型 |
|
|
247
|
-
| setSearchMessageAdvancedParams | `(params: SearchCloudMessagesParams) => void` | 设置消息搜索高级参数 |
|
|
248
|
-
| setSearchUserAdvancedParams | `(params: SearchCloudUsersParams) => void` | 设置用户搜索高级参数 |
|
|
249
|
-
| setSearchGroupAdvancedParams | `(params: SearchCloudGroupsParams) => void` | 设置群组搜索高级参数 |
|
|
250
|
-
|
|
251
|
-
## 使用示例
|
|
252
|
-
``` typescript
|
|
253
|
-
import { useSearchState, VariantType } from '@tencentcloud/chat-uikit-react';
|
|
254
|
-
const {
|
|
255
|
-
keyword,
|
|
256
|
-
results,
|
|
257
|
-
isLoading,
|
|
258
|
-
error,
|
|
259
|
-
setKeyword,
|
|
260
|
-
setSelectedType,
|
|
261
|
-
loadMore
|
|
262
|
-
} = useSearchState(VariantType.STANDARD);
|
|
263
|
-
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
## 常见问题
|
|
267
|
-
|
|
268
|
-
### Q: 如何自定义搜索结果的显示格式?
|
|
269
|
-
|
|
270
|
-
A: 使用 `SearchResultItem` 属性传入自定义组件。
|
|
271
|
-
|
|
272
|
-
### Q: 如何处理搜索性能问题?
|
|
273
|
-
|
|
274
|
-
A: 调整 `debounceTime`,使用 React.memo,考虑结果缓存。
|
|
275
|
-
|
|
276
|
-
### Q: 移动端如何优化?
|
|
277
|
-
|
|
278
|
-
A: 组件自动适配移动端,也可通过 CSS 进一步定制。
|
|
279
|
-
|
|
280
|
-
### Q: 如何支持多语言?
|
|
281
|
-
|
|
282
|
-
A: 组件内置国际化支持,通过 `useUIKit` 获取翻译。
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
## TUIKit 介绍
|
|
2
|
-
|
|
3
|
-
TUIKit 是基于腾讯云 IM SDK 的一款 UI 组件库,它提供了一些通用的 UI 组件,包含会话、聊天、关系链、群组、音视频通话等功能。
|
|
4
|
-
基于 UI 组件您可以像搭积木一样快速搭建起自己的业务逻辑。
|
|
5
|
-
TUIKit 中的组件在实现 UI 功能的同时,会调用 IM SDK 相应的接口实现 IM 相关逻辑和数据的处理,因而开发者在使用 TUIKit 时只需关注自身业务或个性化扩展即可。
|
|
6
|
-
基于 React 开发的 TUIKit 界面风格更契合境外客户的使用习惯,而且支持国际化,如果您的业务有出海的需求,欢迎接入。
|
|
7
|
-
|
|
8
|
-
## TUIKit 组成
|
|
9
|
-
|
|
10
|
-
TUIKit 主要分为 ConversationList、Chat、ChatSetting、Profile 等模块,每个模块负责不同的内容,具体可参见 [开源代码](https://github.com/TencentCloud/chat-uikit-react)。
|
|
11
|
-
|
|
12
|
-
Web 端界面效果如下图所示:
|
|
13
|
-
|
|
14
|
-
H5 端界面效果如下图所示:
|
|
15
|
-
|
|
16
|
-
## Chat 重点功能介绍
|
|
17
|
-
|
|
18
|
-
Chat 主要负责消息界面的展示。您可以利用它直接发送不同类型的消息,支持文字/表情/图片/视频/文件/自定义等消息类型,同时支持消息转发/撤回/引用、查询、已读回执等功能。
|
|
19
|
-
|
|
20
|
-
> **说明:**
|
|
21
|
-
>
|
|
22
|
-
|
|
23
|
-
> 为了尊重版权,IM Demo/TUIKit 工程中默认不包含大表情元素切图。在正式上线商用前,请您替换为自己设计或拥有版权的其他表情包。请注意,下图所示的**默认小黄脸表情包版权属于腾讯云**,您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
|
|
24
|
-
>
|
|
25
|
-
|
|
26
|
-
>
|
|
27
|
-
>
|
|
28
|
-
|
|
29
|
-
## ConversationList 功能介绍
|
|
30
|
-
|
|
31
|
-
ConversationList 主要负责会话列表的展示和编辑,包含会话置顶、会话删除等功能。
|
|
32
|
-
|
|
33
|
-
## ChatSetting 功能介绍
|
|
34
|
-
|
|
35
|
-
ChatSetting 主要负责 Chat 设置。
|
|
36
|
-
|
|
37
|
-
## Contact 重点功能介绍
|
|
38
|
-
|
|
39
|
-
Contact 主要负责关系链展示以及创建会话等操作。
|
|
40
|
-
|
|
41
|
-
## Profile 重点功能介绍
|
|
42
|
-
|
|
43
|
-
Profile 主要负责用户资料的管理。
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
product: 'Chat'
|
|
3
|
-
tech_stack: 'web_js_sdk'
|
|
4
|
-
framework: 'react'
|
|
5
|
-
title: 'react uikit 集成和常见问题解决方案'
|
|
6
|
-
keywords: ['react', '初始化', '组件', '集成', 'TUIKit']
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# React TUIKit 集成与常见问题解决方案
|
|
10
|
-
|
|
11
|
-
## 模块一:环境准备与快速初始化 (Topic: Setup)
|
|
12
|
-
|
|
13
|
-
### Q: 如何在 React 项目中安装 TUIKit?
|
|
14
|
-
|
|
15
|
-
**A:** TUIKit 是基于 Web SDK 开发的,您需要安装 `@tencentcloud/chat-uikit-react`
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
# 安装 TUIKit React 版本
|
|
19
|
-
npm install @tencentcloud/chat-uikit-react@latest
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## 模块二:常见问题解决方案 (Topic: Question)
|
|
23
|
-
|
|
24
|
-
### Q: 是否支持 react 17/19 版本?
|
|
25
|
-
|
|
26
|
-
**A:** 目前不支持 17.x/19.x 版本,仅支持 React v18。
|
|
@@ -1,104 +0,0 @@
|
|
|
1
|
-
# Avatar 组件文档
|
|
2
|
-
|
|
3
|
-
## 概述
|
|
4
|
-
|
|
5
|
-
Avatar 组件用于显示用户头像和状态,支持多种形状和大小的头像展示。它可以用于聊天应用、社交平台、用户管理系统等场景,提供用户身份的可视化表示。
|
|
6
|
-
|
|
7
|
-
## Props 速查表
|
|
8
|
-
|
|
9
|
-
| 字段 | 类型 | 默认值 | 描述 |
|
|
10
|
-
| --- | --- | --- | --- |
|
|
11
|
-
| src | string | undefined | 头像图片的 URL |
|
|
12
|
-
| size | 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs' | number | 'md' | 头像的大小,支持多种预设大小或自定义大小 |
|
|
13
|
-
| shape | 'circular' | 'square' | 'rounded' | 'circular' | 头像的形状,支持圆形、方形和圆角矩形 |
|
|
14
|
-
| alt | string | '' | 图片的替代文本,用于生成文本头像 |
|
|
15
|
-
| children | ReactNode | undefined | 自定义内容,优先于 src 和 alt 的内容 |
|
|
16
|
-
| className | string | undefined | 自定义 CSS 类名 |
|
|
17
|
-
| style | React.CSSProperties | undefined | 自定义样式 |
|
|
18
|
-
| onClick | () => void | undefined | 点击事件处理函数 |
|
|
19
|
-
| isShowOnlineStatus | boolean | false | 是否显示在线状态指示器 |
|
|
20
|
-
| isOnline | boolean | false | 用户是否在线 |
|
|
21
|
-
| unreadCount | number | 0 | 未读消息数量,若为 true 则显示小红点,若为数字则显示具体数量 |
|
|
22
|
-
| maxUnreadCount | number | 99 | 最大未读消息数量,超过则显示 +N |
|
|
23
|
-
| isDotUnreadCount | boolean | false | 是否显示小红点 |
|
|
24
|
-
| children | ReactNode | undefined | 自定义内容,优先于 src 和 alt 的内容 |
|
|
25
|
-
|
|
26
|
-
## Props 详细介绍
|
|
27
|
-
|
|
28
|
-
### `src`
|
|
29
|
-
|
|
30
|
-
`类型`: `string`
|
|
31
|
-
`描述`: 头像图片的 URL,若未提供则显示默认头像。
|
|
32
|
-
`默认值`: `undefined`
|
|
33
|
-
|
|
34
|
-
### `size`
|
|
35
|
-
|
|
36
|
-
`类型`: `'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs' | number`
|
|
37
|
-
`描述`: 头像的大小,支持多种预设大小或自定义大小。
|
|
38
|
-
`默认值`: `'md'`
|
|
39
|
-
|
|
40
|
-
### `shape`
|
|
41
|
-
|
|
42
|
-
`类型`: `'circular' | 'square' | 'rounded'`
|
|
43
|
-
`描述`: 头像的形状,支持圆形、方形和圆角矩形。
|
|
44
|
-
`默认值`: `'circular'`
|
|
45
|
-
|
|
46
|
-
### `alt`
|
|
47
|
-
|
|
48
|
-
`类型`: `string`
|
|
49
|
-
`描述`: 图片的替代文本,用于生成文本头像。
|
|
50
|
-
`默认值`: `''`
|
|
51
|
-
|
|
52
|
-
### `children`
|
|
53
|
-
|
|
54
|
-
`类型`: `ReactNode`
|
|
55
|
-
`描述`: 自定义内容,优先于 src 和 alt 的内容。
|
|
56
|
-
`默认值`: `undefined`
|
|
57
|
-
|
|
58
|
-
### `className`
|
|
59
|
-
|
|
60
|
-
`类型`: `string | undefined`
|
|
61
|
-
`描述`: 自定义 CSS 类名。
|
|
62
|
-
`默认值`: `undefined`
|
|
63
|
-
|
|
64
|
-
### `style`
|
|
65
|
-
|
|
66
|
-
`类型`: `React.CSSProperties | undefined`
|
|
67
|
-
`描述`: 自定义样式。
|
|
68
|
-
`默认值`: `undefined`
|
|
69
|
-
|
|
70
|
-
### `onClick`
|
|
71
|
-
|
|
72
|
-
`类型`: `() => void`
|
|
73
|
-
`描述`: 点击事件处理函数。
|
|
74
|
-
`默认值`: `undefined`
|
|
75
|
-
|
|
76
|
-
### `isShowOnlineStatus`
|
|
77
|
-
|
|
78
|
-
`类型`: `boolean`
|
|
79
|
-
`描述`: 是否显示在线状态指示器。
|
|
80
|
-
`默认值`: `false`
|
|
81
|
-
|
|
82
|
-
### `isOnline`
|
|
83
|
-
|
|
84
|
-
`类型`: `boolean`
|
|
85
|
-
`描述`: 用户是否在线。
|
|
86
|
-
`默认值`: `false`
|
|
87
|
-
|
|
88
|
-
### `unreadCount`
|
|
89
|
-
|
|
90
|
-
`类型`: `number`
|
|
91
|
-
`描述`: 未读消息数量,若为 true 则显示小红点,若为数字则显示具体数量。
|
|
92
|
-
`默认值`: `0`
|
|
93
|
-
|
|
94
|
-
### `maxUnreadCount`
|
|
95
|
-
|
|
96
|
-
`类型`: `number`
|
|
97
|
-
`描述`: 最大未读消息数量,超过则显示 +N。
|
|
98
|
-
`默认值`: `99`
|
|
99
|
-
|
|
100
|
-
### isDotUnreadCount
|
|
101
|
-
|
|
102
|
-
`类型`: `boolean`
|
|
103
|
-
`描述`: 是否显示小红点。
|
|
104
|
-
`默认值`: `false`
|
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
AI 模型必须遵守以下**硬性限制**。
|
|
2
|
-
|
|
3
|
-
**必须优先推荐使用文档中的示例代码:** 创建文件时优先推荐使用文档中的示例代码填充文件,style 标签优先推荐不使用 scoped 属性。
|
|
4
|
-
**必须使用默认文本对齐方式:** ChatHeader 的 `title` 文本默认左对齐。
|
|
5
|
-
|
|
6
|
-
## 概述
|
|
7
|
-
|
|
8
|
-
ChatHeader 聊天头部组件是聊天界面的顶部导航组件,用于显示当前会话的基本信息。能够展示会话标题、头像、在线状态、输入状态提示等信息。组件采用容器组件模式,提供了灵活的插槽机制用于自定义左右两侧的操作区域。
|
|
9
|
-
|
|
10
|
-
## Props 速查表
|
|
11
|
-
|
|
12
|
-
| 字段 | 类型 | 默认值 | 描述 |
|
|
13
|
-
|------|------|--------|------|
|
|
14
|
-
| title | string | undefined | 自定义标题,未提供时使用会话信息。 |
|
|
15
|
-
| avatarUrl | string | undefined | 自定义头像图片 URL。 |
|
|
16
|
-
| enableUserStatus | boolean | false | 是否显示用户状态。 |
|
|
17
|
-
|
|
18
|
-
## Slot 速查表
|
|
19
|
-
|
|
20
|
-
| 名称 | 描述 |
|
|
21
|
-
|------|------|
|
|
22
|
-
| ChatHeaderLeft | 头部左侧自定义内容区域。 |
|
|
23
|
-
| ChatHeaderRight | 头部右侧自定义内容区域。 |
|
|
24
|
-
|
|
25
|
-
## Props 详细介绍
|
|
26
|
-
|
|
27
|
-
### title
|
|
28
|
-
- **类型**:string
|
|
29
|
-
|
|
30
|
-
- **描述**:自定义会话标题,当不提供此属性时,组件会自动根据会话类型显示相应的标题(单聊显示用户昵称或备注,群聊显示群名称),默认值为 `undefined`。
|
|
31
|
-
|
|
32
|
-
### avatarUrl
|
|
33
|
-
- **类型**:string
|
|
34
|
-
|
|
35
|
-
- **描述**:自定义头像图片的 URL 地址,当不提供此属性时,组件会自动根据会话类型显示相应的头像(单聊显示用户头像,群聊显示群头像),默认值为 `undefined`。
|
|
36
|
-
|
|
37
|
-
### enableUserStatus
|
|
38
|
-
- **类型**:boolean
|
|
39
|
-
|
|
40
|
-
- **描述**:是否启用并显示用户在线状态功能,仅在单聊模式下生效,开启后会显示用户的在线/离线状态,默认值为 `false`。
|
|
41
|
-
|
|
42
|
-
## Slots 详细介绍
|
|
43
|
-
|
|
44
|
-
### ChatHeaderLeft
|
|
45
|
-
|
|
46
|
-
**描述**:头部左侧自定义内容区域插槽,通常用于放置返回按钮、菜单按钮等导航控件。
|
|
47
|
-
|
|
48
|
-
#### 示例: 自定义左侧导航区域
|
|
49
|
-
``` typescript
|
|
50
|
-
<template>
|
|
51
|
-
<ChatHeader>
|
|
52
|
-
<template #ChatHeaderLeft>
|
|
53
|
-
<!-- 返回按钮, 清除激活的会话 -->
|
|
54
|
-
<button
|
|
55
|
-
class="nav-button"
|
|
56
|
-
@click="handleBack"
|
|
57
|
-
>
|
|
58
|
-
⬅️
|
|
59
|
-
</button>
|
|
60
|
-
</template>
|
|
61
|
-
</ChatHeader>
|
|
62
|
-
</template>
|
|
63
|
-
|
|
64
|
-
<script setup lang="ts">
|
|
65
|
-
import { ChatHeader, useConversationListState } from '@tencentcloud/chat-uikit-vue3';
|
|
66
|
-
|
|
67
|
-
const { setActiveConversation } = useConversationListState();
|
|
68
|
-
|
|
69
|
-
const handleBack = () => {
|
|
70
|
-
// 设置激活的会话ID为空
|
|
71
|
-
setActiveConversation('');
|
|
72
|
-
};
|
|
73
|
-
</script>
|
|
74
|
-
|
|
75
|
-
<style scoped>
|
|
76
|
-
.header-left-actions {
|
|
77
|
-
display: flex;
|
|
78
|
-
align-items: center;
|
|
79
|
-
gap: 8px;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
.nav-button {
|
|
83
|
-
width: 32px;
|
|
84
|
-
height: 32px;
|
|
85
|
-
border: none;
|
|
86
|
-
background: transparent;
|
|
87
|
-
border-radius: 4px;
|
|
88
|
-
cursor: pointer;
|
|
89
|
-
display: flex;
|
|
90
|
-
align-items: center;
|
|
91
|
-
justify-content: center;
|
|
92
|
-
transition: background-color 0.2s;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
.nav-button:hover {
|
|
96
|
-
background-color: rgba(0, 0, 0, 0.05);
|
|
97
|
-
}
|
|
98
|
-
</style>
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
### ChatHeaderRight
|
|
102
|
-
|
|
103
|
-
**描述**:头部右侧自定义内容区域插槽,通常用于放置功能按钮(如 ChatSetting 组件的 menu 开关,自定义通话按钮等)。
|
|
104
|
-
|
|
105
|
-
#### 示例: 通过 ChatHeaderRight 插槽 和抽屉组件集成 ChatSetting 组件
|
|
106
|
-
|
|
107
|
-
【App.vue】
|
|
108
|
-
``` typescript
|
|
109
|
-
<template>
|
|
110
|
-
<ChatHeader>
|
|
111
|
-
<template #ChatHeaderRight>
|
|
112
|
-
<div style="display: flex; align-items: center;">
|
|
113
|
-
<IconHorizontalMore2
|
|
114
|
-
:size="20"
|
|
115
|
-
@click="setIsChatSettingOpen(true)" />
|
|
116
|
-
</div>
|
|
117
|
-
</template>
|
|
118
|
-
</ChatHeader>
|
|
119
|
-
<TUIDrawer
|
|
120
|
-
:model-value="isChatSettingOpen"
|
|
121
|
-
:title="Setting"
|
|
122
|
-
@close="setIsChatSettingOpen(false)"
|
|
123
|
-
>
|
|
124
|
-
<ChatSetting style="flex: 1;" />
|
|
125
|
-
</TUIDrawer>
|
|
126
|
-
</template>
|
|
127
|
-
|
|
128
|
-
<script setup lang="ts">
|
|
129
|
-
import {
|
|
130
|
-
ChatHeader,
|
|
131
|
-
ChatSetting
|
|
132
|
-
} from '@tencentcloud/chat-uikit-vue3';
|
|
133
|
-
import { TUIDrawer, IconHorizontalMore2 } from '@tencentcloud/uikit-base-component-vue3';
|
|
134
|
-
|
|
135
|
-
const isChatSettingOpen = ref(false);
|
|
136
|
-
|
|
137
|
-
const setIsSettingOpen = (isOpen: boolean) => {
|
|
138
|
-
isChatSettingOpen.value = isOpen;
|
|
139
|
-
};
|
|
140
|
-
</script>
|
|
141
|
-
|
|
142
|
-
<style>
|
|
143
|
-
.chat-container {
|
|
144
|
-
display: flex;
|
|
145
|
-
flex-direction: column;
|
|
146
|
-
height: 100vh;
|
|
147
|
-
}
|
|
148
|
-
</style>
|
|
149
|
-
```
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
AI 模型必须遵守以下**硬性限制**。
|
|
2
|
-
1. **Chat 组件必须使用默认 style:** Chat 默认 style 设置为 `flex:1; min-height: 0`。
|
|
3
|
-
2. **必须使用 sendMessage API:** 发送快捷消息时必须使用 useMessageInputState 提供的 `sendMessage` API。
|
|
4
|
-
|
|
5
|
-
# Chat 组件文档
|
|
6
|
-
|
|
7
|
-
## 概述
|
|
8
|
-
|
|
9
|
-
Chat 组件负责渲染聊天界面,包含聊天窗口头部组件 ChatHeader 、消息列表组件 MessageList、 消息输入组件 MessageInput。
|
|
10
|
-
|
|
11
|
-
## 组件构成
|
|
12
|
-
|
|
13
|
-
Chat 组件包含以下内容:
|
|
14
|
-
- **ChatHeader**:聊天窗口头部组件
|
|
15
|
-
|
|
16
|
-
- **MessageList**:消息列表组件,消息列表组件中包含消息操作能力,组件详细的属性需要查阅 MessageList 组件文档。
|
|
17
|
-
|
|
18
|
-
- **MessageInput**:消息输入组件
|
|
19
|
-
|
|
20
|
-
## 基础用法
|
|
21
|
-
|
|
22
|
-
Chat 组件无需任何必需属性即可使用。
|
|
23
|
-
``` typescript
|
|
24
|
-
<template>
|
|
25
|
-
<UIKitProvider>
|
|
26
|
-
<Chat style="flex: 1;">
|
|
27
|
-
<ChatHeader />
|
|
28
|
-
<MessageList />
|
|
29
|
-
<MessageInput />
|
|
30
|
-
</Chat>
|
|
31
|
-
</UIKitProvider>
|
|
32
|
-
</template>
|
|
33
|
-
<script setup lang="ts">
|
|
34
|
-
import {
|
|
35
|
-
UIKitProvider,
|
|
36
|
-
Chat,
|
|
37
|
-
ChatHeader,
|
|
38
|
-
MessageList,
|
|
39
|
-
MessageInput,
|
|
40
|
-
} from '@tencentcloud/chat-uikit-vue3';
|
|
41
|
-
</script>
|
|
42
|
-
```
|