@tencent-rtc/mcp 1.4.7 → 1.6.0

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.
Files changed (553) hide show
  1. package/cursor-setting.png +0 -0
  2. package/index.js +0 -1
  3. package/knowledge/bm25-cache.js +73 -0
  4. package/knowledge/bm25.js +147 -0
  5. package/knowledge/build-index.js +69 -0
  6. package/knowledge/chunker.js +167 -0
  7. package/knowledge/content-loader.js +39 -0
  8. package/knowledge/doc-url-resolver.js +142 -0
  9. package/knowledge/extractors.js +25 -0
  10. package/knowledge/path-meta.js +184 -0
  11. package/knowledge/search/exact-lookup.js +497 -0
  12. package/knowledge/search/filter-pool.js +104 -0
  13. package/knowledge/search/product-scope-intent.js +40 -0
  14. package/knowledge/search/requires-framework.js +81 -0
  15. package/knowledge/search/search-knowledge.js +229 -0
  16. package/mcp-server-prompt.png +0 -0
  17. package/package.json +1 -1
  18. package/resource/_schema/feature-aliases.yaml +10 -0
  19. package/resource/_schema/goal-tags.yaml +72 -0
  20. package/resource/_schema/products.yaml +19 -0
  21. package/resource/_schema/trtc-intents.yaml +27 -0
  22. package/resource/_schema/types.yaml +43 -0
  23. package/resource/index/component-slugs.json +1 -0
  24. package/resource/index/doc-source-urls.json +1 -0
  25. package/resource/index/manifest.json +1 -0
  26. package/resource/{doc → integration}/callkit/preset/android/integration.md +34 -28
  27. package/resource/integration/callkit/preset/flutter/integration.md +346 -0
  28. package/resource/integration/callkit/preset/ios/integration.md +408 -0
  29. package/resource/integration/callkit/preset/react/integration.md +362 -0
  30. package/resource/integration/callkit/preset/vue/integration.md +356 -0
  31. package/resource/integration/chat/preset/android/integration.md +500 -0
  32. package/resource/integration/chat/preset/flutter/integration.md +370 -0
  33. package/resource/integration/chat/preset/ios/integration.md +566 -0
  34. package/resource/integration/chat/preset/react/integration.md +490 -0
  35. package/resource/integration/chat/preset/vue/integration.md +504 -0
  36. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +26 -22
  37. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +22 -18
  38. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +309 -0
  39. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +47 -39
  40. package/resource/integration/roomkit/preset/vue/integration.md +562 -0
  41. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +828 -0
  42. package/resource/knowledge/callkit/core-sdk/android/make-call.md +897 -0
  43. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +363 -0
  44. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1111 -0
  45. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1132 -0
  46. package/resource/{doc → knowledge}/callkit/core-sdk/flutter/offline-push.md +174 -151
  47. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1084 -0
  48. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1252 -0
  49. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +534 -0
  50. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  51. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  52. package/resource/knowledge/callkit/faq/android.md +92 -0
  53. package/resource/{doc/callkit/faq/android-faq.md → knowledge/callkit/faq/common.md} +11 -12
  54. package/resource/knowledge/callkit/faq/error-code.md +67 -0
  55. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  56. package/resource/knowledge/callkit/faq/ios.md +104 -0
  57. package/resource/knowledge/callkit/faq/web.md +74 -0
  58. package/resource/knowledge/callkit/preset/android/api.md +412 -0
  59. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  60. package/resource/knowledge/callkit/preset/ios/api.md +234 -0
  61. package/resource/knowledge/callkit/preset/web/api.md +83 -0
  62. package/resource/knowledge/chat/preset/android/features/chat-setting.md +74 -0
  63. package/resource/knowledge/chat/preset/android/features/contact-list.md +43 -0
  64. package/resource/knowledge/chat/preset/android/features/conversation-list.md +117 -0
  65. package/resource/knowledge/chat/preset/android/features/language.md +136 -0
  66. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  67. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  68. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  69. package/resource/knowledge/chat/preset/android/features/theme.md +222 -0
  70. package/resource/knowledge/chat/preset/android-view/integration.md +300 -0
  71. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +64 -0
  72. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  73. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  74. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  75. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  76. package/resource/knowledge/chat/preset/flutter/features/message-list.md +158 -0
  77. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  78. package/resource/knowledge/chat/preset/flutter/features/theme.md +261 -0
  79. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +94 -0
  80. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  81. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  82. package/resource/knowledge/chat/preset/ios/features/language.md +125 -0
  83. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  84. package/resource/knowledge/chat/preset/ios/features/message-list.md +162 -0
  85. package/resource/knowledge/chat/preset/ios/features/search.md +93 -0
  86. package/resource/knowledge/chat/preset/ios/features/theme.md +270 -0
  87. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +160 -158
  88. package/resource/knowledge/chat/preset/react/features/chat-setting.md +101 -0
  89. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +43 -41
  90. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +215 -0
  91. package/resource/knowledge/chat/preset/react/features/conversation-list.md +339 -0
  92. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +101 -0
  93. package/resource/knowledge/chat/preset/react/features/conversation-search.md +61 -0
  94. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +117 -156
  95. package/resource/knowledge/chat/preset/react/features/message-list.md +297 -0
  96. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/search.md +65 -59
  97. package/resource/knowledge/chat/preset/react/features/theme.md +93 -0
  98. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  99. package/resource/knowledge/chat/preset/vue/features/chat-setting.md +79 -0
  100. package/resource/knowledge/chat/preset/vue/features/contact-list.md +277 -0
  101. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +234 -0
  102. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +331 -0
  103. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +216 -0
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +13 -13
  105. package/resource/knowledge/chat/preset/vue/features/message-input.md +551 -0
  106. package/resource/knowledge/chat/preset/vue/features/message-list.md +350 -0
  107. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +79 -73
  108. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  109. package/resource/knowledge/chat/urls/error-code.md +17 -0
  110. package/resource/knowledge/chat/urls/product.md +43 -0
  111. package/resource/knowledge/chat/urls/restapi.md +204 -0
  112. package/resource/knowledge/chat/urls/sdk/android.md +80 -0
  113. package/resource/knowledge/chat/urls/sdk/flutter.md +71 -0
  114. package/resource/knowledge/chat/urls/sdk/ios.md +80 -0
  115. package/resource/knowledge/chat/urls/sdk/web.md +80 -0
  116. package/resource/knowledge/chat/urls/webhook.md +68 -0
  117. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +286 -0
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +55 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  122. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +51 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  127. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  128. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +488 -0
  129. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +219 -0
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +282 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +153 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  135. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +426 -0
  137. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +52 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  140. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +150 -0
  141. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +438 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +190 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +291 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  148. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +51 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  154. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +487 -0
  155. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +183 -0
  156. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +736 -0
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +53 -47
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +28 -24
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +22 -18
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +17 -15
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +19 -18
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +102 -89
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +41 -37
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +45 -43
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +23 -20
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +41 -41
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +70 -69
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +68 -71
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +43 -47
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +59 -56
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +103 -105
  172. package/resource/knowledge/livekit/core-sdk/live/flutter/live-host-interaction.md +869 -0
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +84 -87
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +43 -40
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +11 -10
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +28 -24
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +22 -18
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +15 -14
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +19 -18
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +54 -50
  181. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +41 -37
  182. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +40 -40
  183. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +19 -18
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +53 -47
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +28 -24
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +22 -18
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +41 -33
  188. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +94 -81
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +35 -30
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +45 -42
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-room-list.md +23 -20
  192. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +260 -0
  193. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +598 -0
  194. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-barrage.md +490 -0
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +65 -59
  196. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +424 -0
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +69 -76
  198. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-room-list.md +726 -0
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +11 -10
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +28 -24
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +22 -18
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +41 -33
  203. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +54 -50
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +35 -30
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +49 -46
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-room-list.md +19 -18
  207. package/resource/knowledge/livekit/faq/error-code.md +193 -0
  208. package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/barrage.md +56 -53
  209. package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-audience-list.md +22 -21
  210. package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-view.md +34 -32
  211. package/resource/knowledge/push/config/android.md +92 -0
  212. package/resource/knowledge/push/config/harmonyos.md +83 -0
  213. package/resource/knowledge/push/config/ios.md +254 -0
  214. package/resource/knowledge/push/config/react-native.md +254 -0
  215. package/resource/knowledge/push/config/unity.md +209 -0
  216. package/resource/knowledge/push/config/unreal-engine.md +194 -0
  217. package/resource/knowledge/push/integration/android.md +404 -0
  218. package/resource/knowledge/push/integration/flutter.md +465 -0
  219. package/resource/knowledge/push/integration/harmonyos.md +63 -0
  220. package/resource/knowledge/push/integration/ios.md +246 -0
  221. package/resource/knowledge/push/integration/react-native.md +366 -0
  222. package/resource/knowledge/push/integration/uni-app.md +208 -0
  223. package/resource/knowledge/push/integration/unity.md +389 -0
  224. package/resource/knowledge/push/integration/unreal-engine.md +390 -0
  225. package/resource/knowledge/push/overview/prepare.md +60 -0
  226. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +241 -0
  227. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +588 -0
  228. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +364 -0
  229. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +340 -0
  230. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  231. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +797 -0
  232. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +325 -0
  233. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +325 -0
  234. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +233 -0
  235. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +569 -0
  236. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +325 -0
  237. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +322 -0
  238. package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +221 -0
  239. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +49 -48
  240. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +461 -0
  241. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +216 -0
  242. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +370 -0
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-participant-state.md +61 -60
  244. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +280 -0
  245. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-view.md +57 -56
  246. package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +319 -0
  247. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +267 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +261 -0
  249. package/resource/knowledge/roomkit/preset/android/integration.md +396 -0
  250. package/resource/knowledge/roomkit/preset/flutter/integration.md +404 -0
  251. package/resource/knowledge/roomkit/preset/ios/integration.md +369 -0
  252. package/resource/knowledge/roomkit/preset/react/integration.md +576 -0
  253. package/resource/knowledge/rtcengine/web/how_to_run_web_sdk_demo.md +44 -0
  254. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +8 -2
  255. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +19 -1
  256. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  257. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +8 -8
  258. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +6 -6
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +3 -3
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +18 -0
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +2 -2
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
  265. package/resource/knowledge/trtc/android/TRTCCloud.md +1915 -0
  266. package/resource/knowledge/trtc/android/TRTCCloudDef.md +1029 -0
  267. package/resource/knowledge/trtc/android/TRTCCloudListener.md +1095 -0
  268. package/resource/knowledge/trtc/android/TRTCStatistics.md +68 -0
  269. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +502 -0
  270. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  271. package/resource/knowledge/trtc/android/TXDeviceManager.md +169 -0
  272. package/resource/knowledge/trtc/android/TXLiteAVCode.md +125 -0
  273. package/resource/knowledge/trtc/c++/ITRTCCloud.md +2069 -0
  274. package/resource/knowledge/trtc/c++/ITRTCStatistics.md +73 -0
  275. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  276. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +391 -0
  277. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1191 -0
  278. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +931 -0
  279. package/resource/knowledge/trtc/c++/TXLiteAVCode.md +127 -0
  280. package/resource/knowledge/trtc/ios/TRTCCloud.md +2118 -0
  281. package/resource/knowledge/trtc/ios/TRTCCloudDef.md +975 -0
  282. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1131 -0
  283. package/resource/knowledge/trtc/ios/TRTCStatistics.md +68 -0
  284. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +423 -0
  285. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  286. package/resource/knowledge/trtc/ios/TXDeviceManager.md +387 -0
  287. package/resource/knowledge/trtc/ios/TXLiteAVCode.md +127 -0
  288. package/server-config.js +0 -1
  289. package/server.js +35 -12
  290. package/streamable-http.js +0 -1
  291. package/tools/call/get_native_call_uikit_integration.js +2 -4
  292. package/tools/call/get_native_callkit_core_integration.js +2 -6
  293. package/tools/call/get_web_call_uikit_integration.js +2 -4
  294. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  295. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  296. package/tools/common/get_usersig.js +0 -1
  297. package/tools/common/present_framework_choice.js +19 -14
  298. package/tools/common/record_answer.js +19 -26
  299. package/tools/common/record_feedback.js +17 -31
  300. package/tools/common/search_trtc_knowledge.js +44 -0
  301. package/tools/definitions/get_native_call_uikit_integration_def.js +3 -2
  302. package/tools/definitions/get_native_callkit_core_integration_def.js +5 -4
  303. package/tools/definitions/get_native_chat_uikit_integration_def.js +5 -3
  304. package/tools/definitions/get_native_livekit_core_integration_def.js +6 -6
  305. package/tools/definitions/get_usersig_def.js +0 -1
  306. package/tools/definitions/get_web_call_uikit_integration_def.js +4 -3
  307. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  308. package/tools/definitions/get_web_live_uikit_integration_def.js +5 -6
  309. package/tools/definitions/get_web_room_core_integration_def.js +49 -0
  310. package/tools/definitions/get_web_room_uikit_integration_def.js +5 -5
  311. package/tools/definitions/integration-boundary.js +5 -0
  312. package/tools/definitions/present_framework_choice_def.js +12 -11
  313. package/tools/definitions/record_answer_def.js +19 -18
  314. package/tools/definitions/record_feedback_def.js +14 -14
  315. package/tools/definitions/search_trtc_knowledge_def.js +39 -0
  316. package/tools/index.js +5 -37
  317. package/tools/live/get_native_livekit_core_integration.js +1 -4
  318. package/tools/live/get_web_live_uikit_integration.js +2 -5
  319. package/tools/room/get_web_room_core_integration.js +47 -0
  320. package/tools/room/get_web_room_uikit_integration.js +2 -4
  321. package/utils/generate-structured-result.js +24 -31
  322. package/utils/generate-usersig.js +0 -1
  323. package/utils/get-device-identifier.js +0 -1
  324. package/utils/get-doc-content.js +14 -9
  325. package/utils/http-get.js +0 -1
  326. package/utils/http-post.js +0 -1
  327. package/utils/report-cls-client.js +18 -21
  328. package/utils/report-es-client.js +1 -2
  329. package/index.js.map +0 -1
  330. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  331. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -852
  332. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -954
  333. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -361
  334. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1160
  335. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1205
  336. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1090
  337. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1248
  338. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -485
  339. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -950
  340. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1052
  341. package/resource/doc/callkit/faq/common/error-code.md +0 -47
  342. package/resource/doc/callkit/faq/flutter-faq.md +0 -115
  343. package/resource/doc/callkit/faq/ios-faq.md +0 -115
  344. package/resource/doc/callkit/faq/web-faq.md +0 -36
  345. package/resource/doc/callkit/preset/android/api.md +0 -296
  346. package/resource/doc/callkit/preset/flutter/api.md +0 -410
  347. package/resource/doc/callkit/preset/flutter/integration.md +0 -164
  348. package/resource/doc/callkit/preset/ios/api.md +0 -80
  349. package/resource/doc/callkit/preset/ios/integration.md +0 -187
  350. package/resource/doc/callkit/preset/react/api.md +0 -501
  351. package/resource/doc/callkit/preset/react/integration.md +0 -86
  352. package/resource/doc/callkit/preset/vue/api.md +0 -501
  353. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  354. package/resource/doc/chatkit/android/faq.md +0 -111
  355. package/resource/doc/chatkit/android/features/theme.md +0 -219
  356. package/resource/doc/chatkit/android/integration.md +0 -490
  357. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -281
  358. package/resource/doc/chatkit/faq/common/product.md +0 -7
  359. package/resource/doc/chatkit/faq/common/server.md +0 -44
  360. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  361. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -199
  362. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -53
  363. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -235
  364. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  365. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -287
  366. package/resource/doc/chatkit/flutter/faq.md +0 -23
  367. package/resource/doc/chatkit/flutter/features/theme.md +0 -235
  368. package/resource/doc/chatkit/flutter/integration.md +0 -344
  369. package/resource/doc/chatkit/ios/faq.md +0 -111
  370. package/resource/doc/chatkit/ios/features/theme.md +0 -267
  371. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  372. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  373. package/resource/doc/chatkit/react/components/chat-setting.md +0 -57
  374. package/resource/doc/chatkit/react/components/chat.md +0 -38
  375. package/resource/doc/chatkit/react/components/component-list.md +0 -37
  376. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  377. package/resource/doc/chatkit/react/components/conversation-list.md +0 -333
  378. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -118
  379. package/resource/doc/chatkit/react/components/conversation-search.md +0 -60
  380. package/resource/doc/chatkit/react/components/message-list.md +0 -293
  381. package/resource/doc/chatkit/react/components/tuikit.md +0 -34
  382. package/resource/doc/chatkit/react/faq.md +0 -26
  383. package/resource/doc/chatkit/react/integration.md +0 -416
  384. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  385. package/resource/doc/chatkit/vue/components/chat-header.md +0 -148
  386. package/resource/doc/chatkit/vue/components/chat-setting.md +0 -62
  387. package/resource/doc/chatkit/vue/components/chat.md +0 -45
  388. package/resource/doc/chatkit/vue/components/component-list.md +0 -87
  389. package/resource/doc/chatkit/vue/components/contact-list.md +0 -271
  390. package/resource/doc/chatkit/vue/components/conversation-actions.md +0 -228
  391. package/resource/doc/chatkit/vue/components/conversation-list.md +0 -320
  392. package/resource/doc/chatkit/vue/components/conversation-preview.md +0 -213
  393. package/resource/doc/chatkit/vue/components/message-input.md +0 -1054
  394. package/resource/doc/chatkit/vue/components/message-list.md +0 -433
  395. package/resource/doc/chatkit/vue/components/tuikit.md +0 -31
  396. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  397. package/resource/doc/chatkit/vue/faq.md +0 -36
  398. package/resource/doc/chatkit/vue/integration.md +0 -428
  399. package/resource/doc/livekit/core-sdk/live/flutter/live-host-interaction.md +0 -866
  400. package/resource/doc/livekit/faq/common/error-code.md +0 -88
  401. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  402. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -91
  403. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -112
  404. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -215
  405. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +0 -300
  406. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  407. package/resource/doc/roomkit/vue/features/call-user-to-room.md +0 -220
  408. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  409. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +0 -215
  410. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  411. package/resource/doc/roomkit/vue/features/room-state.md +0 -282
  412. package/resource/doc/roomkit/vue/features/schedule-room.md +0 -318
  413. package/resource/doc/roomkit/vue/features/screen-share.md +0 -265
  414. package/resource/doc/roomkit/vue/features/virtual-background.md +0 -271
  415. package/resource/doc/roomkit/vue/integration.md +0 -315
  416. package/resource/doc/rtcengine/faq/common/error_code.md +0 -1
  417. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  418. package/resource/doc/rtcengine/web/.gitkeep +0 -0
  419. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +0 -59
  420. package/resource/doc/trtc/C++/ITRTCCloud.md +0 -1970
  421. package/resource/doc/trtc/C++/ITRTCStatistics.md +0 -70
  422. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -469
  423. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -387
  424. package/resource/doc/trtc/C++/TRTCCloudCallback.md +0 -1082
  425. package/resource/doc/trtc/C++/TRTCTypeDef.md +0 -925
  426. package/resource/doc/trtc/C++/TXLiteAVCode.md +0 -129
  427. package/resource/doc/trtc/android/TRTCCloud.md +0 -1815
  428. package/resource/doc/trtc/android/TRTCCloudDef.md +0 -992
  429. package/resource/doc/trtc/android/TRTCCloudListener.md +0 -1004
  430. package/resource/doc/trtc/android/TRTCStatistics.md +0 -65
  431. package/resource/doc/trtc/android/TXAudioEffectManager.md +0 -469
  432. package/resource/doc/trtc/android/TXBeautyManager.md +0 -402
  433. package/resource/doc/trtc/android/TXDeviceManager.md +0 -173
  434. package/resource/doc/trtc/android/TXLiteAVCode.md +0 -127
  435. package/resource/doc/trtc/iOS/TRTCCloud.md +0 -2028
  436. package/resource/doc/trtc/iOS/TRTCCloudDef.md +0 -958
  437. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +0 -1046
  438. package/resource/doc/trtc/iOS/TRTCStatistics.md +0 -65
  439. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +0 -397
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -403
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -381
  442. package/resource/doc/trtc/iOS/TXLiteAVCode.md +0 -130
  443. package/server-config.js.map +0 -1
  444. package/server.js.map +0 -1
  445. package/streamable-http.js.map +0 -1
  446. package/tools/call/get_callkit_api.js +0 -33
  447. package/tools/call/get_callkit_api.js.map +0 -1
  448. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  449. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  450. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  452. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  453. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  454. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  455. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  456. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  457. package/tools/common/get_faq.js +0 -266
  458. package/tools/common/get_faq.js.map +0 -1
  459. package/tools/common/get_usersig.js.map +0 -1
  460. package/tools/common/present_framework_choice.js.map +0 -1
  461. package/tools/common/record_answer.js.map +0 -1
  462. package/tools/common/record_feedback.js.map +0 -1
  463. package/tools/common/record_skill_session.js +0 -69
  464. package/tools/common/record_skill_session.js.map +0 -1
  465. package/tools/definitions/get_callkit_api_def.js +0 -29
  466. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  467. package/tools/definitions/get_faq_def.js +0 -47
  468. package/tools/definitions/get_faq_def.js.map +0 -1
  469. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  472. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  473. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  474. package/tools/definitions/get_native_livekit_core_features_def.js +0 -34
  475. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  476. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  478. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  479. package/tools/definitions/get_usersig_def.js.map +0 -1
  480. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  482. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  483. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  485. package/tools/definitions/get_web_livekit_api_def.js +0 -30
  486. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  487. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -32
  488. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  489. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -31
  491. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -27
  493. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -27
  495. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -27
  497. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  498. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  499. package/tools/definitions/record_answer_def.js.map +0 -1
  500. package/tools/definitions/record_feedback_def.js.map +0 -1
  501. package/tools/definitions/record_skill_session_def.js +0 -31
  502. package/tools/definitions/record_skill_session_def.js.map +0 -1
  503. package/tools/index.js.map +0 -1
  504. package/tools/live/get_native_livekit_core_features.js +0 -68
  505. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  506. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  507. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  508. package/tools/live/get_web_livekit_api.js +0 -33
  509. package/tools/live/get_web_livekit_api.js.map +0 -1
  510. package/tools/live/get_web_livekit_component_detail.js +0 -35
  511. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  512. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  513. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  514. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  516. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  518. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  520. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  521. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  522. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  523. package/utils/build-session-directives.js +0 -120
  524. package/utils/build-session-directives.js.map +0 -1
  525. package/utils/generate-structured-result.js.map +0 -1
  526. package/utils/generate-usersig.js.map +0 -1
  527. package/utils/get-device-identifier.js.map +0 -1
  528. package/utils/get-doc-content.js.map +0 -1
  529. package/utils/handle-framework.js +0 -9
  530. package/utils/handle-framework.js.map +0 -1
  531. package/utils/handle-state-name.js +0 -29
  532. package/utils/handle-state-name.js.map +0 -1
  533. package/utils/http-get.js.map +0 -1
  534. package/utils/http-post.js.map +0 -1
  535. package/utils/report-cls-client.js.map +0 -1
  536. package/utils/report-es-client.js.map +0 -1
  537. package/utils/report-runtime-error-cls-client.js +0 -91
  538. package/utils/report-runtime-error-cls-client.js.map +0 -1
  539. /package/resource/{doc/livekit/preset/live/vue/faq.md → knowledge/push/config/donut.md} +0 -0
  540. /package/resource/{doc/roomkit/vue/faq.md → knowledge/push/integration/donut.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  542. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
@@ -1,62 +0,0 @@
1
- ## Component Overview
2
-
3
- ChatSetting is an intelligent chat settings component that automatically renders the appropriate settings interface based on the currently active conversation type. The component internally integrates two modes: C2C (1-to-1) chat settings and group chat settings, providing users with a unified chat settings entry point.
4
-
5
- Core features of the component:
6
- - **Auto-adaptive**: Automatically switches the settings interface based on conversation type (C2C or group chat).
7
-
8
- - **State-driven**: Automatically updates content based on the currently active conversation state.
9
-
10
- > **Note:**
11
- >
12
-
13
- > Will not be displayed if there is no active conversation.
14
- >
15
-
16
- ## Quick Start
17
-
18
- ChatSetting is a standalone component that can be used freely. For flexibility in component usage, UIKit does not provide a default usage pattern.
19
-
20
- The recommended approach is to use the `ChatHeaderRight` slot of the ChatHeader component to control the display of `ChatSetting`. Here's the sample code:
21
- ``` typescript
22
- <template>
23
- <UIKitProvider>
24
- <Chat>
25
- <ChatHeader>
26
- <template #ChatHeaderRight>
27
- <button @click="toggleChatSetting">
28
- ⚙️ Settings
29
- </button>
30
- </template>
31
- </ChatHeader>
32
- <MessageList />
33
- <MessageInput />
34
- </Chat>
35
- <Drawer
36
- :open="isSettingVisible"
37
- title="Chat Settings"
38
- >
39
- <ChatSetting />
40
- </Drawer>
41
- </UIKitProvider>
42
- </template>
43
-
44
- <script setup lang="ts">
45
- import { ref } from 'vue';
46
- import { ChatHeader } from '@tencentcloud/chat-uikit-vue3';
47
- // Assuming you have a Drawer component
48
- import { Drawer } from 'your-ui-library';
49
-
50
- const isSettingVisible = ref(false);
51
-
52
- const toggleChatSetting = () => {
53
- isSettingVisible.value = !isSettingVisible.value;
54
- };
55
- </script>
56
- ```
57
-
58
- ## Related Documentation
59
-
60
- - [chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
61
-
62
- - [GitHub Demo](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/demos/rtcube-vite-vue3)
@@ -1,45 +0,0 @@
1
-
2
- The AI model must adhere to the following **hard constraints**:
3
-
4
- 1. **The Chat component must use the default style:** The default style for Chat is set to `flex:1; min-height: 0`.
5
-
6
- 2. **The sendMessage API must be used:** When sending quick messages, the `sendMessage` API provided by useMessageInputState must be used.
7
-
8
- # Chat component document
9
-
10
- ## Overview
11
-
12
- The chat component renders the chat interface, including the chat window header component ChatHeader, message list component MessageList, and message input component MessageInput.
13
-
14
- ## Component composition
15
-
16
- The Chat component includes the following content:
17
- -**ChatHeader**: The chat window header component
18
-
19
- - **MessageList**: The message list component, which includes message operation capabilities. For detailed properties, read the MessageList component document.
20
-
21
- - **MessageInput**: The message input component
22
-
23
- ## Basic Usage
24
-
25
- Chat components can be used without any required attributes.
26
- ```vue
27
- <template>
28
- <UIKitProvider>
29
- <Chat style="flex: 1;">
30
- <ChatHeader />
31
- <MessageList />
32
- <MessageInput />
33
- </Chat>
34
- </UIKitProvider>
35
- </template>
36
- <script setup lang="ts">
37
- import {
38
- UIKitProvider,
39
- Chat,
40
- ChatHeader,
41
- MessageList,
42
- MessageInput,
43
- } from '@tencentcloud/chat-uikit-vue3';
44
- </script>
45
- ```
@@ -1,87 +0,0 @@
1
- # atomicx component library Manifest and components Application scenarios and considerations
2
-
3
- ## Component list
4
-
5
- 25 components:
6
-
7
- ### Components suitable for chat scenarios
8
-
9
- 1. ConversationList
10
- Session list component, suitable for chat scenarios, in vertical list form, can switch sessions through click. If only chat is needed, this component is optional.
11
- 2. MessageInput
12
- Message input component, the core component for chat scenarios, can send chat messages. To send a message, you must use this component.
13
- 3. MessageList
14
- Message list component, the core component for chat scenarios, can display chat message lists, support swipe. This component must use in chat scenarios.
15
- 4. ContactList
16
- Contact list component, suitable for chat scenarios, can display and manage user contacts. If only chat is needed, this component is optional.
17
- 5. ChatSetting
18
- Chat settings component, suitable for chat scenarios, manages configuration details such as pin to top, do not disturb, add or remove users in group chat, admin management, and mute. If only chat is needed, this component is optional.
19
- 6. Search
20
- Search component, used for message search, user search, etc. If only chat is needed, this component is optional.
21
-
22
- ### Components suitable for meeting scenarios
23
-
24
- 1. CameraButton
25
- Camera control button, applicable only to meeting scenarios, used to turn the camera on/off
26
- 2. StreamView
27
- Video stream display component, applicable only to meeting scenarios, used to display video stream
28
- 3. UserList
29
- User list component, applicable only to meeting scenarios, displays users in the meeting or room
30
- 4. VideoSetting
31
- Video settings component, applicable only to meeting scenarios, for camera, image quality and other video configuration
32
- 5. VideoSettingPanel
33
- Video settings panel, applicable only to meeting scenarios, provides a complete video configuration interface
34
- 6. AudioSetting
35
- Audio settings component, applicable only to meeting scenarios, can be configured for microphone, volume and other device configuration
36
- 7. AudioSettingPanel
37
- Audio settings panel, applicable only to meeting scenarios, provides a complete audio configuration interface
38
- 8. BarrageInput
39
- Danmu input component, suitable for meeting and live-streaming scenarios, used for sending Danmu messages.
40
- 9. BarrageList
41
- Danmu list component, suitable for meeting and live-streaming scenarios, displays Danmu messages in the live streaming room.
42
- 10. UserPicker
43
- User selector, suitable for meeting and live-streaming scenarios, used to invite users or assign permissions.
44
- 11. MicButton
45
- Microphone control button, suitable for meeting and live-streaming scenarios, used for mute/unmute.
46
-
47
- ### Components for live streaming scenarios
48
-
49
- 1. CoGuestPanel
50
- Co-anchoring guest management panel, only applicable to live broadcast scenarios, used for the co-anchoring function.
51
- 2. LiveAudienceList
52
- Live viewers list, only applicable to live broadcast scenarios, displaying current live streaming room audience.
53
- 3. LiveList
54
- Live room list, only applicable to live broadcast scenarios, shows available live streaming rooms.
55
- 4. LiveMonitorView
56
- Live monitoring view, only applicable to live broadcast scenarios, for live stream management and monitoring.
57
- 5. LiveScenePanel
58
- Live streaming control panel, only applicable to live broadcast scenarios, manage live streaming scenarios and effects.
59
- 6. LiveStreamView
60
- Live video stream display component, only applicable to live broadcast scenarios, plays live stream.
61
- 7. StreamMixer
62
- Stream mixer component, only applicable to live broadcast scenarios, used for multiple video stream synthesis.
63
- 8. BarrageInput
64
- Danmu input component, suitable for meeting and live-streaming scenarios, used for sending Danmu messages.
65
- 9. BarrageList
66
- Danmu list component, suitable for meeting and live-streaming scenarios, displays Danmu messages in the live streaming room.
67
- 10. UserPicker
68
- User selector, suitable for meeting and live-streaming scenarios, used to invite users or assign permissions.
69
- 11. MicButton
70
- Microphone control button, suitable for meeting and live-streaming scenarios, used for mute/unmute.
71
-
72
- ### universal component
73
-
74
- 1. Avatar
75
- Common avatar component, displays user profile photo, online status, and message unread count.
76
- 2. UserPicker
77
- User selector, used to initiate group chat, group video, or group voice calls in user selection scenarios.
78
-
79
- ## Must-Knows
80
-
81
- Before integrating any component into a real project, **must** first ensure the integration documentation has been obtained using the following tool and integrate according to the documentation:
82
-
83
- 1. When creating a real project, call the component integration documentation of MCP Tools get_atomicx_integration_guide(framework).
84
- 2. When choosing to use components, first consider the minimum components that meet the requirements, then consider recommended additional extension components. Do not enlarge the requirements.
85
- 3. Components that apply to different scenarios may have an intersection.
86
- 4. According to the user needs, judge if it might be a comprehensive scenario, such as chat + live stream. The probability is low, so proceed with caution.
87
- 5. To learn about the method of use for a specific component, ask the user: "You can ask how to use ${componentname}?"
@@ -1,271 +0,0 @@
1
- ## Overview
2
-
3
- ContactList is a highly configurable contact list component. This component supports friend lists, group lists, blacklists, and application management, providing core features such as group collapsing, search filtering, and custom rendering. It's suitable for contact management interfaces in instant messaging and social applications.
4
-
5
- ## ContactList Props
6
- | Field | Type | Default Value | Description |
7
- | --- | --- | --- | --- |
8
- | activeContactItem | ContactGroupItem \\| undefined | undefined | Currently active contact item |
9
- | enableSearch | boolean | true | Whether to enable search functionality |
10
- | groupConfig | Partial<Record<ContactItemType, CustomGroupConfig>> | {} | Custom group configuration |
11
- | searchPlaceholder | string | 'Search contacts' | Search box placeholder text |
12
- | emptyText | string | 'No contacts' | Empty state message text |
13
- | ContactItem | Component \\| undefined | ContactListItem | Custom contact item component |
14
- | ContactSearchComponent | Component \\| undefined | ContactSearch | Custom search component |
15
- | GroupHeader | Component \\| undefined | Default group header | Custom group header component |
16
- | PlaceholderEmptyList | Component \\| undefined | Default empty state | Custom empty state component |
17
- | onContactItemClick | (item: ContactGroupItem) => void | undefined | Contact item click event |
18
- | onFriendApplicationAction | (action: 'accept' \\| 'refuse', application: FriendApplication) => void | undefined | Friend application action event |
19
- | onGroupApplicationAction | (action: 'accept' \\| 'refuse', application: GroupApplication) => void | undefined | Group application action event |
20
-
21
- ## ContactList Events
22
- | Event Name | Parameters | Description |
23
- | --- | --- | --- |
24
- | contact-item-click | (item: ContactGroupItem) | Contact item click event |
25
- | friend-application-action | (action: 'accept' \\| 'refuse', application: FriendApplication) | Friend application action event |
26
- | group-application-action | (action: 'accept' \\| 'refuse', application: GroupApplication) | Group application action event |
27
-
28
- ## ContactInfo Props
29
- | Field | Type | Default Value | Description |
30
- | --- | --- | --- | --- |
31
- | contactItem | ContactGroupItem \\| undefined | undefined | Currently displayed contact item |
32
- | showActions | boolean | true | Whether to show action buttons |
33
- | PlaceholderEmpty | Component \\| undefined | undefined | Empty state placeholder component |
34
- | FriendInfoComponent | Component | FriendInfo | Friend info component |
35
- | GroupInfoComponent | Component | GroupInfo | Group info component |
36
- | BlacklistInfoComponent | Component | BlacklistInfo | Blacklist info component |
37
- | FriendApplicationInfoComponent | Component | FriendApplicationInfo | Friend application info component |
38
- | GroupApplicationInfoComponent | Component | GroupApplicationInfo | Group application info component |
39
- | SearchGroupInfoComponent | Component | SearchGroupInfo | Search group info component |
40
- | SearchUserInfoComponent | Component | SearchUserInfo | Search user info component |
41
-
42
- ## ContactInfo Events
43
- | Event Name | Parameters | Description |
44
- | --- | --- | --- |
45
- | close | - | Close info panel event |
46
- | sendMessage | (friend: Friend) | Send message event |
47
- | deleteFriend | (friend: Friend) | Delete friend event |
48
- | addToBlacklist | (friend: Friend) | Add to blacklist event |
49
- | removeFromBlacklist | (profile: UserProfile) | Remove from blacklist event |
50
- | updateFriendRemark | (friend: Friend) | Update friend remark event |
51
- | enterGroup | (group: GroupModel) | Enter group event |
52
- | leaveGroup | (group: GroupModel) | Leave group event |
53
- | dismissGroup | (group: GroupModel) | Dismiss group event |
54
- | friendApplicationAction | (action: 'accept' \\| 'refuse', application: FriendApplication) | Friend application action event |
55
- | groupApplicationAction | (action: 'accept' \\| 'refuse', application: GroupApplication) | Group application action event |
56
- | addFriend | (user: UserProfile, wording: string) | Add friend event |
57
- | joinGroup | (group: GroupModel, note: string) | Join group event |
58
-
59
- ## Basic Usage
60
- ``` typescript
61
- <template>
62
- <div class="contact-container">
63
- <ContactList />
64
- <ContactInfo />
65
- </div>
66
- </template>
67
-
68
- <script setup lang="ts">
69
- import { ContactList, ContactInfo } from '@tencentcloud/chat-uikit-vue3';
70
- </script>
71
-
72
- <style scoped>
73
- .contact-container {
74
- display: flex;
75
- height: 100vh;
76
- }
77
- </style>
78
- ```
79
-
80
- ## Customization
81
-
82
- ### Customize Contact List Search Toggle
83
-
84
- By setting the `enableSearch` parameter, you can flexibly control the display of the friend/group search functionality in ContactList.
85
- ``` typescript
86
- <template>
87
- <ContactList :enableSearch="false" />
88
- </template>
89
- ```
90
- | enableSearch="true" | enableSearch="false" |
91
- | --- | --- |
92
- | | |
93
-
94
- ### Customize Contact List Group Configuration
95
-
96
- `groupConfig` is used to customize group configuration, including title, display order, hiding groups, etc.
97
- ``` typescript
98
- <template>
99
- <ContactList :groupConfig="customGroupConfig" />
100
- </template>
101
-
102
- <script setup lang="ts">
103
- import { ContactList } from '@tencentcloud/chat-uikit-vue3';
104
- import { ContactItemType } from '@tencentcloud/chat-uikit-vue3';
105
-
106
- const customGroupConfig = {
107
- [ContactItemType.FRIEND]: {
108
- title: 'My Friends',
109
- order: 1,
110
- },
111
- [ContactItemType.GROUP]: {
112
- title: 'Group Chats',
113
- order: 2,
114
- },
115
- [ContactItemType.BLACK]: {
116
- hidden: true,
117
- },
118
- [ContactItemType.FRIEND_REQUEST]: {
119
- title: 'Friend Requests',
120
- order: 0,
121
- }
122
- };
123
- </script>
124
- ```
125
- | Before | After |
126
- | --- | --- |
127
- | | |
128
-
129
- ### Customize Contact List Items
130
-
131
- You can fully control the rendering of contact list items by passing in a custom `ContactItem` component.
132
- ``` typescript
133
- <template>
134
- <div class="custom-contact-item" @click="handleClick">
135
- <label>Custom Contact</label>
136
- <span v-if="props.contactItem.type === ContactItemType.FRIEND">{{ props.contactItem.data.nick }}</span>
137
- <span v-if="props.contactItem.type === ContactItemType.GROUP">{{ props.contactItem.data.name }}</span>
138
- </div>
139
- </template>
140
- <script setup lang="ts">
141
- import { ContactItemType } from '@tencentcloud/chat-uikit-vue3';
142
-
143
- const props = defineProps<{
144
- contactItem: any;
145
- }>();
146
- const emit = defineEmits<{
147
- click: [type: ContactItemType, item: any];
148
- }>();
149
- const handleClick = () => {
150
- emit('click', props.contactItem.type, props.contactItem.data);
151
- };
152
- </script>
153
- <style scoped>
154
- .custom-contact-item {
155
- display: flex;
156
- align-items: center;
157
- gap: 10px;
158
- padding: 10px 20px;
159
- border-bottom: 1px solid #eee;
160
- }
161
- </style>
162
-
163
- ```
164
- ``` typescript
165
- <template>
166
- <ContactList :ContactItem="CustomContactItem" />
167
- </template>
168
-
169
- <script setup lang="ts">
170
- import { ContactList } from '@tencentcloud/chat-uikit-vue3';
171
- import CustomContactItem from './CustomContactItem.vue';
172
- </script>
173
- ```
174
- | Before | After |
175
- | --- | --- |
176
- | | |
177
-
178
- ### Customize Contact Details Action Button Toggle
179
-
180
- By setting the `showActions` parameter, you can control the display of action buttons on the contact details page.
181
- ``` typescript
182
- <template>
183
- <ContactInfo
184
- :showActions="false"
185
- />
186
- </template>
187
- ```
188
- | Before | After |
189
- | --- | --- |
190
- | | |
191
-
192
- ### Customize Contact Details Empty State
193
-
194
- When no contact is selected, you can customize the empty state component to display.
195
- ``` typescript
196
- <template>
197
- <div>
198
- Custom Empty State
199
- </div>
200
- </template>
201
- ```
202
- ``` typescript
203
- <template>
204
- <ContactInfo
205
- :PlaceholderEmpty="CustomEmpty"
206
- />
207
- </template>
208
-
209
- <script setup lang="ts">
210
- import { ContactList } from '@tencentcloud/chat-uikit-vue3';
211
- import CustomEmpty from './CustomEmpty.vue';
212
- </script>
213
- ```
214
-
215
- ### Customize Friend Details Component
216
-
217
- You can customize the detail display component for different types of contacts.
218
- ``` typescript
219
- <template>
220
- <div class="custom-contact-info">
221
- <label>Custom Friend Details</label>
222
- <div class="friend-info">
223
-
224
- <span>{{ friend.nick }}</span>
225
- </div>
226
- </div>
227
- </template>
228
- <script setup lang="ts">
229
- import type { Friend } from '@tencentcloud/chat-uikit-vue3';
230
-
231
- defineProps<{
232
- friend: Friend;
233
- }>();
234
- </script>
235
- <style scoped>
236
- .custom-contact-info {
237
- display: flex;
238
- flex-direction: column;
239
- gap: 10px;
240
- padding: 20px;
241
- }
242
- .friend-info {
243
- display: flex;
244
- justify-content: space-between;
245
- align-items: center;
246
- gap: 10px;
247
- }
248
- .avatar {
249
- width: 60px;
250
- height: 60px;
251
- border-radius: 50%
252
- }
253
- </style>
254
-
255
- ```
256
- ``` typescript
257
- <template>
258
- <ContactInfo
259
- :FriendInfoComponent="CustomFriendInfo"
260
- />
261
- </template>
262
-
263
- <script setup lang="ts">
264
- import { defineComponent, h } from 'vue';
265
- import type { FriendInfoProps, GroupInfoProps } from '@tencentcloud/chat-uikit-vue3';
266
- import CustomFriendInfo from './CustomFriendInfo.vue';
267
- </script>
268
- ```
269
- | Before | After |
270
- | --- | --- |
271
- | | |
@@ -1,228 +0,0 @@
1
- ## Overview
2
-
3
- The ConversationActions component handles operations for a single conversation, supporting delete, pin, mute, and mark unread/read by default.
4
-
5
- ## Basic Usage
6
-
7
- In `ConversationList`, you can quickly customize conversation actions using the `actionsConfig` prop.
8
- ``` typescript
9
- <template>
10
- <UIKitProvider>
11
- <ConversationList :actions-config="actionsConfig" />
12
- </UIKitProvider>
13
- </template>
14
-
15
- <script setup lang="ts">
16
- import { UIKitProvider, ConversationList } from '@tencentcloud/chat-uikit-vue3';
17
- import type { ConversationModel } from '@tencentcloud/chat-uikit-vue3';
18
-
19
- const actionsConfig = {
20
- enablePin: false,
21
- onConversationDelete: (conversation: ConversationModel) => {
22
- console.log('Delete conversation success');
23
- },
24
- customConversationActions: {
25
- 'custom-actions-1': {
26
- label: 'custom-actions',
27
- onClick: (conversation: ConversationModel) => {
28
- console.log(conversation);
29
- },
30
- },
31
- },
32
- };
33
- </script>
34
- ```
35
-
36
- ## Advanced Usage
37
-
38
- For deeper customization, you can directly replace the `ConversationActions` prop of `ConversationList`.
39
- ``` typescript
40
- <template>
41
- <UIKitProvider>
42
- <ConversationList
43
- :ConversationActions="CustomConversationActions"
44
- />
45
- </UIKitProvider>
46
- </template>
47
-
48
- <script setup lang="ts">
49
- import { defineComponent } from 'vue';
50
- import { UIKitProvider, ConversationList, ConversationActions } from '@tencentcloud/chat-uikit-vue3';
51
- import type { ConversationActionsProps } from '@tencentcloud/chat-uikit-vue3';
52
-
53
- const CustomConversationActions = defineComponent({
54
- name: 'CustomConversationActions',
55
- setup(props: ConversationActionsProps) {
56
- return () => h(ConversationActions, {
57
- ...props,
58
- enableDelete: false
59
- });
60
- }
61
- });
62
- </script>
63
- ```
64
-
65
- ## Props
66
-
67
- The `ConversationActionsProps` interface type for the ConversationActions component extends from the `ConversationActionsConfig` interface.
68
-
69
- ### ConversationActionsProps
70
- | Parameter | Type | Default | Description |
71
- | --- | --- | --- | --- |
72
- | conversation(Required) | ConversationModel | - | Required parameter, represents the conversation for the current rendered conversation action |
73
- | className | string | - | Custom class name for root element |
74
- | style | CSSProperties | - | Custom style for root element |
75
-
76
- ### ConversationActionsConfig
77
- | Parameter | Type | Default | Description |
78
- | --- | --- | --- | --- |
79
- | enablePin | boolean | true | Whether to show the pin action button |
80
- | enableMute | boolean | true | Whether to show the mute action button |
81
- | enableDelete | boolean | true | Whether to show the delete action button |
82
- | enableMarkUnread | boolean | true | Whether to show the mark unread action button |
83
- | onMarkConversationUnread | (conversation: ConversationModel, e?: Event) => void | - | Custom callback for marking conversation as unread/read |
84
- | onConversationPin | (conversation: ConversationModel, e?: Event) => void | - | Custom callback for pinning/unpinning conversation |
85
- | onConversationMute | (conversation: ConversationModel, e?: Event) => void | - | Custom callback for muting/unmuting conversation |
86
- | onConversationDelete | (conversation: ConversationModel, e?: Event) => void | - | Custom callback for deleting conversation |
87
- | customConversationActions | Record<string, ConversationActionItem> | - | Custom conversation action items |
88
- | PopupIcon | any | - | Custom icon for action popup |
89
- | PopupElements | any[] | - | Custom content for action popup |
90
- | onClick | (e: Event, key?: string, conversation?: ConversationModel) => void | - | Callback when clicking action item |
91
- | onClose | () => void | - | Callback when closing action popup (H5 only) |
92
-
93
- ### ConversationActionItem
94
- | Parameter | Type | Default | Description |
95
- | --- | --- | --- | --- |
96
- | enable | boolean | true | Whether to enable the custom action item |
97
- | label | string | - | Display content for custom action item |
98
- | onClick | (conversation: ConversationModel, e?: Event) => void | - | Callback when clicking custom action item |
99
-
100
- ## Events
101
- | Event Name | Parameters | Description |
102
- | --- | --- | --- |
103
- | click | (e: Event, key?: string, conversation?: ConversationModel) | Triggered when clicking an action item |
104
- | close | () | Triggered when closing the action popup |
105
- | markConversationUnread | (conversation: ConversationModel, e?: Event) | Triggered when marking conversation as unread/read |
106
- | conversationPin | (conversation: ConversationModel, e?: Event) | Triggered when pinning/unpinning conversation |
107
- | conversationMute | (conversation: ConversationModel, e?: Event) | Triggered when muting/unmuting conversation |
108
- | conversationDelete | (conversation: ConversationModel, e?: Event) | Triggered when deleting conversation |
109
-
110
- ## Custom Components
111
-
112
- ### Basic Feature Toggles
113
-
114
- By setting `enablePin`, `enableDelete`, `enableMute`, and `enableMarkUnread` parameters, you can flexibly control the display of conversation pin, mute, delete, and mark unread in `ConversationActions`.
115
- ``` typescript
116
- <template>
117
- <!-- Disable pin feature -->
118
- <ConversationActions :enablePin="false" :conversation="conversation" />
119
-
120
- <!-- Disable delete feature -->
121
- <ConversationActions :enableDelete="false" :conversation="conversation" />
122
-
123
- <!-- Disable mute feature -->
124
- <ConversationActions :enableMute="false" :conversation="conversation" />
125
-
126
- <!-- Disable mark unread feature -->
127
- <ConversationActions :enableMarkUnread="false" :conversation="conversation" />
128
- </template>
129
- ```
130
- | `enablePin: false` | `enableDelete: false` | `enableMute: false` | enableMarkUnread="false" |
131
- | --- | --- | --- | --- |
132
- | | | | |
133
-
134
- ### Event Handling
135
-
136
- The ConversationActions component supports conversation delete, pin/unpin, mute/unmute, and mark unread/read by default. If the existing event handling doesn't meet your needs, you can customize and override the event handling functions. In addition to customizing event handling, you can also get basic click events through `@click`.
137
- ``` typescript
138
- <template>
139
- <ConversationList :conversation-actions="CustomConversationActions" />
140
- </template>
141
-
142
- <script setup lang="ts">
143
- import { defineComponent, h } from 'vue';
144
- import { ConversationActions, Toast } from '@tencentcloud/chat-uikit-vue3';
145
- import type { ConversationActionsProps, ConversationModel } from '@tencentcloud/chat-uikit-vue3';
146
-
147
- const CustomConversationActions = defineComponent({
148
- name: 'CustomConversationActions',
149
- setup(props: ConversationActionsProps) {
150
- const handleConversationDelete = (conversation: ConversationModel) => {
151
- conversation.deleteConversation().then(() => {
152
- console.log('delete conversation successfully!');
153
- }).catch(() => {
154
- console.log('delete conversation failed!');
155
- });
156
- };
157
-
158
- return () => h(ConversationActions, {
159
- ...props,
160
- onConversationDelete: handleConversationDelete
161
- });
162
- }
163
- });
164
- </script>
165
- ```
166
-
167
- ### Custom Actions
168
-
169
- customConversationActions is used to add custom action items to ConversationActions.
170
-
171
- **Example: Add Custom Action Item**
172
- ``` typescript
173
- <template>
174
- <ConversationList :ConversationActions="CustomConversationActions" />
175
- </template>
176
-
177
- <script setup lang="ts">
178
- import { defineComponent, h } from 'vue';
179
- import { ConversationActions } from '@tencentcloud/chat-uikit-vue3';
180
- import type { ConversationActionsProps, ConversationModel } from '@tencentcloud/chat-uikit-vue3';
181
-
182
- const CustomConversationActions = defineComponent({
183
- name: 'CustomConversationActions',
184
- setup(props: ConversationActionsProps) {
185
- return () => h(ConversationActions, {
186
- ...props,
187
- customConversationActions: {
188
- 'custom-actions-1': {
189
- label: 'custom-actions',
190
- onClick: (conversation: ConversationModel) => {
191
- console.log(conversation);
192
- },
193
- },
194
- }
195
- });
196
- }
197
- });
198
- </script>
199
- ```
200
-
201
- ### UI Customization
202
-
203
- You can customize the popup trigger button style through the `PopupIcon` parameter, and customize the popup content through `PopupElements`.
204
-
205
- **Example: Custom Trigger Button**
206
- ``` typescript
207
- <template>
208
- <ConversationList :ConversationActions="CustomConversationActions" />
209
- </template>
210
-
211
- <script setup lang="ts">
212
- import { defineComponent, h } from 'vue';
213
- import { ConversationActions } from '@tencentcloud/chat-uikit-vue3';
214
- import type { ConversationActionsProps } from '@tencentcloud/chat-uikit-vue3';
215
-
216
- const CustomConversationActions = defineComponent({
217
- name: 'CustomConversationActions',
218
- setup(props: ConversationActionsProps) {
219
- const customIcon = h('div', '自定义 Icon');
220
-
221
- return () => h(ConversationActions, {
222
- ...props,
223
- PopupIcon: customIcon
224
- });
225
- }
226
- });
227
- </script>
228
- ```