@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.
Files changed (556) hide show
  1. package/index.js +0 -1
  2. package/knowledge/bm25-cache.js +73 -0
  3. package/knowledge/bm25.js +147 -0
  4. package/knowledge/build-index.js +65 -0
  5. package/knowledge/chunker.js +167 -0
  6. package/knowledge/content-loader.js +44 -0
  7. package/knowledge/extractors.js +25 -0
  8. package/knowledge/path-meta.js +175 -0
  9. package/knowledge/search/exact-lookup.js +330 -0
  10. package/knowledge/search/filter-pool.js +86 -0
  11. package/knowledge/search/requires-framework.js +72 -0
  12. package/knowledge/search/search-knowledge.js +226 -0
  13. package/package.json +9 -9
  14. package/resource/_schema/feature-aliases.yaml +10 -0
  15. package/resource/_schema/goal-tags.yaml +72 -0
  16. package/resource/_schema/products.yaml +16 -0
  17. package/resource/_schema/trtc-intents.yaml +27 -0
  18. package/resource/_schema/types.yaml +44 -0
  19. package/resource/index/component-slugs.json +1 -0
  20. package/resource/index/manifest.json +1 -0
  21. package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
  22. package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
  23. package/resource/integration/callkit/preset/ios/integration.md +411 -0
  24. package/resource/integration/callkit/preset/react/integration.md +499 -0
  25. package/resource/integration/callkit/preset/vue/integration.md +768 -0
  26. package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
  27. package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
  28. package/resource/integration/chat/preset/ios/integration.md +568 -0
  29. package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
  30. package/resource/integration/chat/preset/uni-app/integration.md +494 -0
  31. package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
  32. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
  33. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
  34. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
  35. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
  36. package/resource/integration/roomkit/preset/vue/integration.md +571 -0
  37. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
  38. package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
  39. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
  40. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
  41. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
  42. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
  43. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
  44. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
  45. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
  46. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  47. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  48. package/resource/knowledge/callkit/faq/android.md +168 -0
  49. package/resource/knowledge/callkit/faq/common.md +180 -0
  50. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  51. package/resource/knowledge/callkit/faq/ios.md +116 -0
  52. package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
  53. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
  54. package/resource/knowledge/callkit/faq/web.md +363 -0
  55. package/resource/knowledge/callkit/preset/android/api.md +413 -0
  56. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  57. package/resource/knowledge/callkit/preset/ios/api.md +256 -0
  58. package/resource/knowledge/callkit/preset/web/api.md +79 -0
  59. package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
  60. package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
  61. package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
  62. package/resource/knowledge/chat/preset/android/features/language.md +142 -0
  63. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  64. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  65. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  66. package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
  67. package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
  68. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
  69. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  70. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  71. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  72. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  73. package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
  74. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  75. package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
  76. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
  77. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  78. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  79. package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
  80. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  81. package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
  82. package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
  83. package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
  84. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
  85. package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
  86. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
  87. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
  88. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
  89. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
  90. package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
  91. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
  92. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
  93. package/resource/knowledge/chat/preset/react/features/search.md +531 -0
  94. package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  96. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
  97. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
  98. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
  99. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
  100. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
  101. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
  102. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
  103. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  106. package/resource/knowledge/chat/urls/error-code.md +16 -0
  107. package/resource/knowledge/chat/urls/product.md +61 -0
  108. package/resource/knowledge/chat/urls/restapi.md +226 -0
  109. package/resource/knowledge/chat/urls/sdk/android.md +84 -0
  110. package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
  111. package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
  112. package/resource/knowledge/chat/urls/sdk/web.md +88 -0
  113. package/resource/knowledge/chat/urls/webhook.md +73 -0
  114. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  117. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  122. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
  127. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  129. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  135. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  137. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
  140. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  148. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
  154. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
  155. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
  156. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
  172. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
  181. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
  182. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
  183. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
  188. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
  192. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
  193. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
  194. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
  196. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
  198. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
  203. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
  207. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
  208. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
  209. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
  210. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
  211. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
  212. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
  213. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
  214. package/resource/knowledge/push/config/android/fcm.md +133 -0
  215. package/resource/knowledge/push/config/android/honor.md +111 -0
  216. package/resource/knowledge/push/config/android/huawei.md +106 -0
  217. package/resource/knowledge/push/config/android/meizu.md +121 -0
  218. package/resource/knowledge/push/config/android/oppo.md +108 -0
  219. package/resource/knowledge/push/config/android/vivo.md +101 -0
  220. package/resource/knowledge/push/config/android/xiaomi.md +99 -0
  221. package/resource/knowledge/push/integration/android.md +1028 -0
  222. package/resource/knowledge/push/integration/donut.md +271 -0
  223. package/resource/knowledge/push/integration/flutter.md +363 -0
  224. package/resource/knowledge/push/integration/harmonyos.md +72 -0
  225. package/resource/knowledge/push/integration/ios.md +705 -0
  226. package/resource/knowledge/push/integration/react-native.md +337 -0
  227. package/resource/knowledge/push/integration/uni-app.md +461 -0
  228. package/resource/knowledge/push/integration/unity.md +357 -0
  229. package/resource/knowledge/push/integration/unreal-engine.md +353 -0
  230. package/resource/knowledge/push/overview/prepare.md +30 -0
  231. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
  232. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
  233. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
  234. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
  235. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  236. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
  237. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
  238. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
  239. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
  240. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
  241. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
  242. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
  244. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
  245. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
  246. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
  247. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
  249. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
  250. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
  251. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
  252. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
  253. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
  254. package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
  255. package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
  256. package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
  257. package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
  258. package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
  265. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
  266. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  267. package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
  268. package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
  269. package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
  270. package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
  271. package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
  272. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  273. package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
  274. package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
  275. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
  276. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
  277. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  278. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
  279. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
  280. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
  281. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
  282. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
  283. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
  284. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
  285. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
  286. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  287. package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
  288. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
  289. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
  290. package/server-config.js +0 -1
  291. package/server.js +22 -12
  292. package/streamable-http.js +0 -1
  293. package/tools/call/get_native_call_uikit_integration.js +2 -4
  294. package/tools/call/get_native_callkit_core_integration.js +2 -6
  295. package/tools/call/get_web_call_uikit_integration.js +2 -4
  296. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  297. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  298. package/tools/common/get_usersig.js +0 -1
  299. package/tools/common/present_framework_choice.js +9 -4
  300. package/tools/common/record_answer.js +19 -26
  301. package/tools/common/record_feedback.js +17 -31
  302. package/tools/common/search_trtc_knowledge.js +44 -0
  303. package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
  304. package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
  305. package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
  306. package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
  307. package/tools/definitions/get_usersig_def.js +0 -1
  308. package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
  309. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  310. package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
  311. package/tools/definitions/get_web_room_core_integration_def.js +46 -0
  312. package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
  313. package/tools/definitions/integration-boundary.js +5 -0
  314. package/tools/definitions/present_framework_choice_def.js +11 -10
  315. package/tools/definitions/record_answer_def.js +6 -5
  316. package/tools/definitions/record_feedback_def.js +4 -3
  317. package/tools/definitions/search_trtc_knowledge_def.js +69 -0
  318. package/tools/index.js +5 -37
  319. package/tools/live/get_native_livekit_core_integration.js +1 -4
  320. package/tools/live/get_web_live_uikit_integration.js +2 -5
  321. package/tools/room/get_web_room_core_integration.js +47 -0
  322. package/tools/room/get_web_room_uikit_integration.js +2 -4
  323. package/utils/generate-structured-result.js +4 -11
  324. package/utils/generate-usersig.js +0 -1
  325. package/utils/get-device-identifier.js +0 -1
  326. package/utils/get-doc-content.js +14 -9
  327. package/utils/http-get.js +0 -1
  328. package/utils/http-post.js +0 -1
  329. package/utils/report-cls-client.js +22 -21
  330. package/utils/report-es-client.js +1 -2
  331. package/utils/report-runtime-error-cls-client.js +0 -1
  332. package/index.js.map +0 -1
  333. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  334. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
  335. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
  336. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
  337. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
  338. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
  339. package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
  340. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
  341. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
  342. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
  343. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
  344. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
  345. package/resource/doc/callkit/faq/android-faq.md +0 -767
  346. package/resource/doc/callkit/faq/flutter-faq.md +0 -749
  347. package/resource/doc/callkit/faq/ios-faq.md +0 -759
  348. package/resource/doc/callkit/faq/web-faq.md +0 -753
  349. package/resource/doc/callkit/preset/android/api.md +0 -330
  350. package/resource/doc/callkit/preset/flutter/api.md +0 -401
  351. package/resource/doc/callkit/preset/ios/api.md +0 -282
  352. package/resource/doc/callkit/preset/ios/integration.md +0 -188
  353. package/resource/doc/callkit/preset/react/api.md +0 -600
  354. package/resource/doc/callkit/preset/react/integration.md +0 -86
  355. package/resource/doc/callkit/preset/vue/api.md +0 -600
  356. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  357. package/resource/doc/chatkit/android/faq.md +0 -109
  358. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
  359. package/resource/doc/chatkit/faq/common/product.md +0 -82
  360. package/resource/doc/chatkit/faq/common/server.md +0 -53
  361. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  362. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
  363. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
  364. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
  365. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  366. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
  367. package/resource/doc/chatkit/flutter/faq.md +0 -22
  368. package/resource/doc/chatkit/ios/faq.md +0 -109
  369. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  370. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  371. package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
  372. package/resource/doc/chatkit/react/components/chat.md +0 -38
  373. package/resource/doc/chatkit/react/components/component-list.md +0 -35
  374. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  375. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
  376. package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
  377. package/resource/doc/chatkit/react/components/search.md +0 -282
  378. package/resource/doc/chatkit/react/components/tuikit.md +0 -43
  379. package/resource/doc/chatkit/react/faq.md +0 -26
  380. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  381. package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
  382. package/resource/doc/chatkit/vue/components/chat.md +0 -42
  383. package/resource/doc/chatkit/vue/components/component-list.md +0 -89
  384. package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
  385. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  386. package/resource/doc/chatkit/vue/faq.md +0 -35
  387. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
  388. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
  389. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
  390. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
  391. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
  392. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
  393. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
  394. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
  395. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
  396. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
  397. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
  398. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
  399. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
  400. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
  401. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
  402. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
  403. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
  404. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
  405. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
  406. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
  407. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
  408. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
  409. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
  410. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
  411. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
  412. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
  413. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
  414. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
  415. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
  416. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
  417. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
  418. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
  419. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  420. package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
  421. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
  422. package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
  423. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
  424. package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
  425. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
  426. package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
  427. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  428. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
  429. package/resource/doc/roomkit/vue/faq.md +0 -1
  430. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  431. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  432. package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
  433. package/resource/doc/roomkit/vue/features/room-state.md +0 -280
  434. package/resource/doc/roomkit/vue/features/room-view.md +0 -241
  435. package/resource/doc/roomkit/vue/integration.md +0 -315
  436. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  437. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
  438. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
  439. package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
  442. package/server-config.js.map +0 -1
  443. package/server.js.map +0 -1
  444. package/streamable-http.js.map +0 -1
  445. package/tools/call/get_callkit_api.js +0 -33
  446. package/tools/call/get_callkit_api.js.map +0 -1
  447. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  448. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  449. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  450. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  452. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  453. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  454. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  455. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  456. package/tools/common/get_faq.js +0 -266
  457. package/tools/common/get_faq.js.map +0 -1
  458. package/tools/common/get_usersig.js.map +0 -1
  459. package/tools/common/present_framework_choice.js.map +0 -1
  460. package/tools/common/record_answer.js.map +0 -1
  461. package/tools/common/record_feedback.js.map +0 -1
  462. package/tools/common/record_skill_session.js +0 -69
  463. package/tools/common/record_skill_session.js.map +0 -1
  464. package/tools/definitions/get_callkit_api_def.js +0 -28
  465. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  466. package/tools/definitions/get_faq_def.js +0 -40
  467. package/tools/definitions/get_faq_def.js.map +0 -1
  468. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  469. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  472. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  473. package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
  474. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  475. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  476. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  478. package/tools/definitions/get_usersig_def.js.map +0 -1
  479. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  480. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  482. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  483. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_livekit_api_def.js +0 -27
  485. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  486. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
  487. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  488. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  489. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  491. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  493. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  495. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  497. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  498. package/tools/definitions/record_answer_def.js.map +0 -1
  499. package/tools/definitions/record_feedback_def.js.map +0 -1
  500. package/tools/definitions/record_skill_session_def.js +0 -31
  501. package/tools/definitions/record_skill_session_def.js.map +0 -1
  502. package/tools/index.js.map +0 -1
  503. package/tools/live/get_native_livekit_core_features.js +0 -68
  504. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  505. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  506. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  507. package/tools/live/get_web_livekit_api.js +0 -33
  508. package/tools/live/get_web_livekit_api.js.map +0 -1
  509. package/tools/live/get_web_livekit_component_detail.js +0 -35
  510. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  511. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  512. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  513. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  514. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  516. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  518. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  520. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  521. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  522. package/utils/build-session-directives.js +0 -122
  523. package/utils/build-session-directives.js.map +0 -1
  524. package/utils/generate-structured-result.js.map +0 -1
  525. package/utils/generate-usersig.js.map +0 -1
  526. package/utils/get-device-identifier.js.map +0 -1
  527. package/utils/get-doc-content.js.map +0 -1
  528. package/utils/handle-framework.js +0 -9
  529. package/utils/handle-framework.js.map +0 -1
  530. package/utils/handle-state-name.js +0 -29
  531. package/utils/handle-state-name.js.map +0 -1
  532. package/utils/http-get.js.map +0 -1
  533. package/utils/http-post.js.map +0 -1
  534. package/utils/report-cls-client.js.map +0 -1
  535. package/utils/report-es-client.js.map +0 -1
  536. package/utils/report-runtime-error-cls-client.js.map +0 -1
  537. /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
  538. /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
  539. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  540. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  542. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  554. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  555. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
  556. /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
@@ -9,7 +9,7 @@ MessageList 组件是聊天界面的核心组件,负责展示消息列表并
9
9
 
10
10
  - 智能滚动:自动滚动到底部,支持手动滚动控制。
11
11
 
12
- - 历史加载:上加载更多历史消息。
12
+ - 历史加载:上拉加载更多历史消息。
13
13
 
14
14
  - 已读回执:支持消息已读状态显示。
15
15
 
@@ -36,25 +36,23 @@ import { UIKitProvider, Chat, MessageList, MessageInput } from '@tencentcloud/ch
36
36
 
37
37
  ```
38
38
 
39
- > **说明:**
40
- >
39
+ 实践建议:
40
+ 1. MessageList 组件需要放在 UIKitProvider、Chat 容器中使用。
41
41
 
42
- > 实践建议:
43
- >
44
- > 1. MessageList 组件需要放在 UIKitProvider、Chat 容器中使用。
45
- > 2. MessageList 建议和 MessageInput 组件搭配使用。
46
- > 3. MessageList 会默认读取当前激活的会话,如果您不集成 ConversationList 组件,请参考 仅集成聊天 文档。
42
+ 2. MessageList 建议和 MessageInput 组件搭配使用。
47
43
 
48
44
  ## Props 字段速查表
49
- | 字段 | 类型 | 默认值 | 描述 |
50
- | --- | --- | --- | --- |
51
- | alignment | 'left' \\| 'right' \\| 'two-sided' | 'two-sided' | 消息的对齐方式,支持左对齐、右对齐和双边对齐。 |
52
- | messageAggregationTime | number | 300 (秒) | 消息聚合的时间间隔(秒),在此时间内发送的同一发送者的消息会被聚合。设置为 0 可禁用消息聚合。 |
53
- | enableReadReceipt | boolean | false | 是否启用消息已读回执功能。 |
54
- | messageActionList | MessageAction[] | undefined | 自定义消息操作列表,例如撤回、删除等。 |
55
- | filter | (message: MessageModel) => boolean | undefined | 自定义消息过滤函数,用于控制哪些消息应该显示。 |
56
- | Message | Component | undefined | 自定义消息组件,用于渲染单条消息。 |
57
- | MessageTimeDivider | Component | undefined | 自定义消息时间分割线组件。 |
45
+
46
+ |字段|类型|默认值|描述|
47
+ |---------|---------|---------|---------|
48
+ |alignment|'left' \| 'right' \| 'two-sided'|'two-sided'|消息的对齐方式,支持左对齐、右对齐和双边对齐。|
49
+ |enableReadReceipt|boolean|false|是否启用消息已读回执功能。|
50
+ |messageActionList|MessageAction[]|undefined|自定义消息操作列表,例如撤回、删除等。|
51
+ |messageAggregationTime|number|300 (秒)|消息聚合的时间间隔(秒),在此时间内发送的同一发送者的消息会被聚合。设置为 0 可禁用消息聚合。|
52
+ |filter|(message: MessageInfo) => boolean|undefined|自定义消息过滤函数,用于控制哪些消息应该显示。|
53
+ |enableReadReceipt|boolean|false|是否启用消息已读回执功能。|
54
+ |Message|Component|undefined|自定义消息组件,用于渲染单条消息。|
55
+ |MessageTimeDivider|Component|undefined|自定义消息时间分割线组件。|
58
56
 
59
57
  ## Props 详细介绍
60
58
 
@@ -84,7 +82,7 @@ import { UIKitProvider, Chat, MessageList, MessageInput } from '@tencentcloud/ch
84
82
 
85
83
  ``` typescript
86
84
  import type { Component } from 'vue';
87
- import type { MessageModel } from '@tencentcloud/chat-uikit-vue3';
85
+ import type { MessageInfo } from '@tencentcloud/chat-uikit-vue3';
88
86
 
89
87
  interface MessageAction {
90
88
  /** 唯一的操作标识符 */
@@ -94,9 +92,9 @@ import { UIKitProvider, Chat, MessageList, MessageInput } from '@tencentcloud/ch
94
92
  /** 操作的图标组件或图标名称 */
95
93
  icon?: Component | string;
96
94
  /** 操作点击时的回调函数 */
97
- onClick?: (message: MessageModel) => void;
95
+ onClick?: (message: MessageInfo) => void;
98
96
  /** 控制操作的可见性,可以是布尔值或一个根据消息决定可见性的函数 */
99
- visible?: boolean | ((message: MessageModel) => boolean);
97
+ visible?: boolean | ((message: MessageInfo) => boolean);
100
98
  /** 自定义组件,如果提供了,将替代默认的标签和图标 */
101
99
  component?: Component;
102
100
  /** 自定义类名 */
@@ -165,7 +163,7 @@ const actions = useMessageActions(['copy', 'recall']);
165
163
  style: {
166
164
  color: 'orange',
167
165
  },
168
- visible: (message) => message.flow === 'in',
166
+ visible: (message) => message.isSentBySelf === false,
169
167
  }, 'quote', 'recall', 'delete']);
170
168
  </script>
171
169
  ```
@@ -187,9 +185,9 @@ const customLikeAction = {
187
185
  key: 'like',
188
186
  label: 'Like',
189
187
  icon: '🩷',
190
- visible: (message) => message.flow === 'in',
188
+ visible: (message) => message.isSentBySelf === false,
191
189
  onClick: (message) => {
192
- console.log('like message:', message.ID);
190
+ console.log('like message:', message.msgID);
193
191
  // 在这里实现点赞逻辑,例如调用后端API
194
192
  },
195
193
  };
@@ -201,9 +199,9 @@ const actions = useMessageActions(['forward', 'copy', 'recall', customLikeAction
201
199
  示例效果:
202
200
 
203
201
  ### filter
204
- - type:((message: MessageModel) => boolean) | undefined
202
+ - type:((message: MessageInfo) => boolean) | undefined
205
203
 
206
- - 详细说明:一个自定义的过滤函数,用于在消息列表渲染之前对消息进行筛选。该函数接收一个 `MessageModel` 类型的消息对象,并返回一个布尔值。如果返回 `true`,则消息会显示;如果返回 `false`,则消息不会显示。默认值为 `undefined`,表示不进行额外过滤(但组件内部会默认过滤掉 `isDeleted` 为 `true` 的消息)。
204
+ - 详细说明:一个自定义的过滤函数,用于在消息列表渲染之前对消息进行筛选。该函数接收一个 `MessageInfo` 类型的消息对象,并返回一个布尔值。如果返回 `true`,则消息会显示;如果返回 `false`,则消息不会显示。默认值为 `undefined`,表示不进行额外过滤(但组件内部会默认过滤掉 `isDeleted` 为 `true` 的消息)。
207
205
 
208
206
  #### 代码示例:过滤掉机器人发送的文本消息
209
207
 
@@ -215,13 +213,13 @@ const actions = useMessageActions(['forward', 'copy', 'recall', customLikeAction
215
213
 
216
214
  <script lang="ts" setup>
217
215
  import { MessageList, MessageType } from '@tencentcloud/chat-uikit-vue3';
218
- import type { MessageModel } from '@tencentcloud/chat-uikit-vue3';
216
+ import type { MessageInfo } from '@tencentcloud/chat-uikit-vue3';
219
217
 
220
218
  // 定义自定义消息过滤函数
221
- const customMessageFilter = (message: MessageModel): boolean => {
219
+ const customMessageFilter = (message: MessageInfo): boolean => {
222
220
  if (
223
221
  message.nick?.includes('_robot')
224
- && message.type === MessageType.TEXT as any
222
+ && message.messageType === MessageType.Text as any
225
223
  ) {
226
224
  return false;
227
225
  }
@@ -235,67 +233,32 @@ const customMessageFilter = (message: MessageModel): boolean => {
235
233
 
236
234
  - 详细说明:用于自定义渲染消息列表中的单个消息组件。
237
235
 
238
- 如果您需要完全控制消息的显示样式和内部逻辑,可以传入一个 Vue 组件来替代默认的消息渲染。自定义组件将接收 `message` (IMessageModel 类型)、`alignment`、`messageActionList` 等 props。默认值会使用内部的默认消息组件 `Message`。
239
-
240
- #### 代码示例:自定义 CUSTOM 消息点击跳转的消息组件
236
+ 如果您需要完全控制消息的显示样式和内部逻辑,可以传入一个 Vue 组件来替代默认的消息渲染。自定义组件将接收 `message` 、`alignment`、`messageActionList` 等 props。默认值会使用内部的默认消息组件 `Message`。
241
237
 
242
- 这个示例展示了如何创建一个自定义消息组件,用于渲染特定 `CUSTOM` 消息(`businessID` 为 `text_link`)为可点击跳转的链接。
243
- ``` typescript
244
- <template>
245
- <MessageList :Message="CustomMessage" />
246
- </template>
238
+ 这个示例展示了如何重写Message 组件实现在自己的消息上显示头像和昵称(默认自己发送的消息不显示头像和昵称)。
247
239
 
248
- <script lang="ts" setup>
249
- import { defineComponent, h } from 'vue';
250
- import { MessageList, Message, MessageType } from '@tencentcloud/chat-uikit-vue3';
251
- import type { MessageModel } from '@tencentcloud/chat-uikit-vue3';
252
-
253
- const CustomMessage = defineComponent({
254
- name: 'CustomMessage',
255
- props: {
256
- message: {
257
- type: Object as () => MessageModel,
258
- required: true,
259
- },
260
- // MessageList 会传递其他 props,这里可以按需接收,例如 alignment, messageActionList 等
261
- },
262
- setup(props) {
263
- return () => {
264
- const { message } = props;
265
-
266
- if (message.type === MessageType.CUSTOM as any) {
267
- const { businessID, ...restData } = JSON.parse(message.payload.data);
268
- if (businessID === 'text_link') {
269
- return h('div', { class: 'custom-text-link-message' }, [
270
- h('div', restData.text),
271
- h('a', { href: restData.link, target: '_blank' }, `跳转到外部网址 ${restData.link}`),
272
- ]);
273
- }
274
- }
275
- // 其他消息类型使用默认消息组件
276
- return h(Message, props);
277
- };
278
- },
279
- });
280
- </script>
281
-
282
- <style scoped>
283
- .custom-text-link-message {
284
- padding: 8px;
285
- background-color: #f0f8ff;
286
- border-radius: 8px;
287
- max-width: 60%;
288
- margin-bottom: 4px;
289
- }
290
-
291
- .custom-text-link-message a {
292
- color: #1890ff;
293
- text-decoration: underline;
294
- }
295
- </style>
296
- ```
240
+ ``` typescript
241
+ <template>
242
+ <MessageList :Message="MessageWithSelfAvatarAndNick" />
243
+ </template>
297
244
 
298
- 示例效果:
245
+ <script lang="ts" setup>
246
+ import { defineComponent, h } from 'vue';
247
+ import { MessageList, Message } from '@tencentcloud/chat-uikit-vue3';
248
+
249
+ const MessageWithSelfAvatarAndNick = defineComponent({
250
+ name: 'MessageWithSelfAvatar',
251
+ inheritAttrs: false,
252
+ setup(_, { attrs }) {
253
+ return () => h(Message as Component, {
254
+ ...attrs,
255
+ removeAvatar: false,
256
+ isHiddenMessageNick: false,
257
+ });
258
+ },
259
+ });
260
+ </script>
261
+ ```
299
262
 
300
263
  ### MessageTimeDivider
301
264
  - 类型:Component | undefined
@@ -304,116 +267,66 @@ const CustomMessage = defineComponent({
304
267
 
305
268
  您可以传入一个 Vue 组件来替代默认的时间分割线渲染。自定义组件将接收 `currentMessage` (当前时间分割线关联的消息)、`previousMessage` (上一条消息) 等 props,可以根据这些信息决定时间分割线的显示逻辑和样式。默认值会使用内部的默认时间分割线组件 `MessageTimeDivider`。
306
269
 
307
- #### 代码示例:自定义时间分割线组件,根据时间展示是否为上班时间
270
+ 这个示例展示了如何创建一个自定义时间分割线组件,根据消息时间判断是否为工作时间,并显示相应的标签和颜色。
308
271
 
309
- 这个示例展示了如何创建一个自定义时间分隔线组件,根据消息时间判断是否为工作时间,并显示相应的标签和颜色。
310
- ``` typescript
311
- <template>
312
- <MessageList :MessageTimeDivider="BusinessTimeDivider" />
313
- </template>
314
-
315
- <script lang="ts" setup>
316
- import { defineComponent, h } from 'vue';
317
- import { MessageList } from '@tencentcloud/chat-uikit-vue3';
318
- import type { MessageModel } from '@tencentcloud/chat-uikit-vue3';
319
-
320
- const BusinessTimeDivider = defineComponent({
321
- name: 'BusinessTimeDivider',
322
- props: {
323
- previousMessage: {
324
- type: Object as () => MessageModel | undefined,
325
- default: undefined,
326
- },
327
- currentMessage: {
328
- type: Object as () => MessageModel,
329
- required: true,
330
- },
331
- },
332
- setup(props) {
333
- if (!props.previousMessage || !props.currentMessage) {
334
- return () => null;
335
- }
336
-
337
- const currentTime = new Date(props.currentMessage.time * 1000);
338
- const prevTime = new Date(props.previousMessage.time * 1000);
339
-
340
- // 跨天或间隔超过4小时才显示
341
- const shouldShow = currentTime.toDateString() !== prevTime.toDateString()
342
- || (currentTime.getTime() - prevTime.getTime()) > 4 * 60 * 60 * 1000;
343
-
344
- if (!shouldShow) {
345
- return () => null;
346
- }
347
-
348
- // 判断工作时间 (9:00-18:00, 周一到周五)
349
- const isWorkingTime = () => {
350
- const hour = currentTime.getHours();
351
- const day = currentTime.getDay();
352
- return day >= 1 && day <= 5 && hour >= 9 && hour <= 18;
353
- };
354
-
355
- const timeLabel = isWorkingTime() ? 'Working' : 'Non working';
356
- const timeColor = isWorkingTime() ? '#52c41a' : '#faad14';
357
-
358
- return () =>
359
- h('div', { style: { textAlign: 'center', margin: '16px 0' } }, [
360
- h('span', {
361
- style: {
362
- backgroundColor: timeColor,
363
- color: 'white',
364
- padding: '2px 8px',
365
- borderRadius: '12px',
366
- marginRight: '8px',
367
- },
368
- }, timeLabel),
369
- currentTime.toLocaleString(),
370
- ]);
371
- },
372
- });
373
- </script>
374
- ```
375
-
376
- 示例效果:
377
-
378
- ## 扩展资料
379
-
380
- `MessageModel` 类型常用字段:
381
- ``` typescript
382
- // MessageModel 接口定义,详细内容请参考 @tencentcloud/chat-uikit-engine 文档
383
- // 这是一个复杂的消息模型,包含消息ID、类型、发送者、内容、时间、状态等属性。
384
- // 示例结构 (非完整定义):
385
- interface MessageModel {
386
- ID: string;
387
- conversationID: string;
388
- type: MessageType;
389
- payload: any;
390
- flow: 'in' | 'out';
391
- from: string;
392
- to: string;
393
- time: number; // Unix 时间戳 (秒)
394
- status: 'unSend' | 'success' | 'fail';
395
- isDeleted: boolean;
396
- isRevoked: boolean;
397
- hasRiskContent: boolean; // 是否包含风险内容
398
- // ... 其他属性
399
- }
400
-
401
- enum MessageType {
402
- TEXT, // 文本
403
- IMAGE, // 图像
404
- AUDIO, // 音频
405
- VIDEO, // 视频
406
- FILE, // 文件
407
- FACE, // 大表情
408
- LOCATION, // 定位
409
- GRP_TIP, // 群提示
410
- CUSTOM, // 自定义
411
- MERGER, // 合并转发
412
- }
413
-
414
- ```
272
+ ``` typescript
273
+ <template>
274
+ <MessageList :MessageTimeDivider="BusinessTimeDivider" />
275
+ </template>
415
276
 
416
- MessageModel 的完整内容请参见:[TUIChatEngine 参考文档](https://web.sdk.qcloud.com/im/doc/chat-engine/IMessageModel.html)。
277
+ <script lang="ts" setup>
278
+ import { defineComponent, h } from 'vue';
279
+ import { MessageList } from '@tencentcloud/chat-uikit-vue3';
280
+ import type { MessageInfo } from '@tencentcloud/chat-uikit-vue3';
281
+
282
+ const BusinessTimeDivider = defineComponent({
283
+ name: 'BusinessTimeDivider',
284
+ props: {
285
+ previousMessage: {
286
+ type: Object as PropType<MessageInfo | undefined>,
287
+ default: undefined,
288
+ },
289
+ currentMessage: {
290
+ type: Object as PropType<MessageInfo>,
291
+ required: true,
292
+ },
293
+ },
294
+ setup(props) {
295
+ return () => {
296
+ if (!props.previousMessage || !props.currentMessage) {
297
+ return null;
298
+ }
299
+
300
+ const currentTime = props.currentMessage.timestamp ?? new Date();
301
+ const previousTime = props.previousMessage.timestamp ?? new Date();
302
+ const shouldShow = currentTime.toDateString() !== previousTime.toDateString()
303
+ || currentTime.getTime() - previousTime.getTime() > 4 * 60 * 60 * 1000;
304
+
305
+ if (!shouldShow) {
306
+ return null;
307
+ }
308
+
309
+ const hour = currentTime.getHours();
310
+ const day = currentTime.getDay();
311
+ const isWorkingTime = day >= 1 && day <= 5 && hour >= 9 && hour <= 18;
312
+
313
+ return h('div', { class: 'message-props-demo__time-divider' }, [
314
+ h(
315
+ 'span',
316
+ {
317
+ class: isWorkingTime
318
+ ? 'message-props-demo__time-label message-props-demo__time-label--work'
319
+ : 'message-props-demo__time-label message-props-demo__time-label--off',
320
+ },
321
+ isWorkingTime ? '工作时间' : '非工作时间',
322
+ ),
323
+ currentTime.toLocaleString(),
324
+ ]);
325
+ };
326
+ },
327
+ });
328
+ </script>
329
+ ```
417
330
 
418
331
  ## 相关文档
419
332
  - 自定义组件 - UIKitProvider
@@ -432,6 +345,6 @@ MessageModel 的完整内容请参见:[TUIChatEngine 参考文档](https://web
432
345
 
433
346
  - [chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
434
347
 
435
- - [github Demo](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/demos/rtcube-vite-vue3)
348
+ - [GitHub Demo](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/demos/rtcube-vite-vue3)
436
349
 
437
350
  ## 交流与反馈
@@ -1,6 +1,6 @@
1
1
  ## 概述
2
2
 
3
- Search 是一个功能完整的搜索解决方案,包含了搜索框、搜索结果展示、高级搜索等功能的完整组件集合。适用于即时通讯、在线会议、在线教育等场景的用户、群组、消息搜索。
3
+ Search 是一个功能完整的搜索解决方案,包含了搜索框、搜索结果展示、高级搜索等功能的完整组件集合。适用于即时通信、在线会议、在线教育等场景的用户、群组、消息搜索。
4
4
 
5
5
  > **说明:**
6
6
  >
@@ -9,29 +9,30 @@ Search 是一个功能完整的搜索解决方案,包含了搜索框、搜索
9
9
  >
10
10
 
11
11
  ## 搜索模式
12
- | **迷你模式 (MINI)** | **标准模式 (STANDARD)** | **嵌入式模式 (EMBEDDED)** |
12
+ | <strong>迷你模式 (MINI)</strong> | <strong>标准模式 (STANDARD)</strong> | <strong>嵌入式模式 (EMBEDDED)</strong> |
13
13
  | --- | --- | --- |
14
14
  | 适用于侧边栏或小容器<br>显示有限结果数量<br>支持展开查看更多 | 适用于全屏搜索界面<br>完整功能展示<br>支持高级搜索 | 适用于聊天界面<br>专注消息搜索<br>优化的布局 |
15
15
 
16
16
  ## Props
17
- | 属性名 | 类型 | 默认值 | 说明 |
18
- | --- | --- | --- | --- |
19
- | variant | VariantType | VariantType.MINI | 搜索模式:mini(迷你)、standard(标准)、embedded(嵌入式) |
20
- | SearchBar | Component<SearchBarProps> | DefaultSearchBar | 自定义搜索框组件 |
21
- | SearchResults | Component<SearchResultsProps> | DefaultSearchResults | 自定义搜索结果组件 |
22
- | SearchAdvanced | Component<SearchAdvancedProps> | DefaultSearchAdvanced | 自定义高级搜索组件 |
23
- | SearchResultsPresearch | Component | - | 搜索前占位符组件 |
24
- | SearchResultsLoading | Component | - | 加载中占位符组件 |
25
- | SearchResultsEmpty | Component | - | 空结果占位符组件 |
26
- | SearchResultItem | Component<ResultItemProps> | - | 自定义搜索结果项组件 |
27
- | debounceTime | number | 300 | 搜索防抖时间(毫秒) |
28
- | autoFocus | boolean | false | 是否自动聚焦搜索框 |
29
- | className | string | - | 自定义样式类名 |
30
- | style | CSSProperties | - | 自定义样式 |
31
- | onKeywordChange | (keyword: string) => void | - | 搜索关键词变化回调 |
32
- | onSearchComplete | (results: Map<SearchType, SearchResult>) => void | - | 搜索完成回调 |
33
- | onResultItemClick | (data: SearchResultItem, type: SearchType) => void | - | 搜索结果点击回调 |
34
- | onError | (error: Error) => void | - | 搜索错误回调 |
17
+
18
+ |属性名|类型|默认值|说明|
19
+ |---------|---------|---------|---------|
20
+ |variant|VariantType|VariantType.MINI|搜索模式:mini(迷你)、standard(标准)、embedded(嵌入式)|
21
+ |SearchBar|Component<SearchBarProps>|DefaultSearchBar|自定义搜索框组件|
22
+ |SearchResults|Component<SearchResultsProps>|DefaultSearchResults|自定义搜索结果组件|
23
+ |SearchAdvanced|Component<SearchAdvancedProps>|DefaultSearchAdvanced|自定义高级搜索组件|
24
+ |SearchResultsPresearch|Component|-|搜索前占位符组件|
25
+ |SearchResultsLoading|Component|-|加载中占位符组件|
26
+ |SearchResultsEmpty|Component|-|空结果占位符组件|
27
+ |SearchResultItem|Component<ResultItemProps>|-|自定义搜索结果项组件|
28
+ |debounceTime|number|300|搜索防抖时间(毫秒)|
29
+ |autoFocus|boolean|false|是否自动聚焦搜索框|
30
+ |className|string|-|自定义样式类名|
31
+ |style|CSSProperties|-|自定义样式|
32
+ |onKeywordChange|(keyword: string) => void|-|搜索关键词变化回调|
33
+ |onSearchComplete|(results: Map<SearchType, SearchResult>) => void|-|搜索完成回调|
34
+ |onResultItemClick|(data: SearchResultItem, type: SearchType) => void|-|搜索结果点击回调|
35
+ |onError|(error: Error) => void|-|搜索错误回调|
35
36
 
36
37
  ## 基础用法
37
38
  ``` typescript
@@ -71,21 +72,22 @@ const handleError = (error: Error) => {
71
72
  【自定义 SearchBar】
72
73
 
73
74
  **Props**
74
- | 属性名 | 类型 | 默认值 | 说明 |
75
- | --- | --- | --- | --- |
76
- | value | string | - | 搜索框值 |
77
- | onChange | (e: Event) => void | - | 输入变化回调 |
78
- | onKeyDown | (e: KeyboardEvent) => void | - | 键盘事件回调 |
79
- | onClear | () => void | - | 清除回调 |
80
- | placeholder | string | - | 占位符文本 |
81
- | SearchIcon | Component | - | 自定义搜索图标 |
82
- | ClearIcon | Component | - | 自定义清除图标 |
83
- | className | string | - | 自定义样式类名 |
84
- | style | CSSProperties | - | 自定义样式 |
85
- | onFocus | (e: FocusEvent) => void | - | 获得焦点回调 |
86
- | onBlur | (e: FocusEvent) => void | - | 失去焦点回调 |
87
- | autoFocus | boolean | false | 是否自动聚焦 |
88
- | variant | VariantType | - | 搜索模式 |
75
+
76
+ |属性名|类型|默认值|说明|
77
+ |---------|---------|---------|---------|
78
+ |value|string|-|搜索框值|
79
+ |onChange|(e: Event) => void|-|输入变化回调|
80
+ |onKeyDown|(e: KeyboardEvent) => void|-|键盘事件回调|
81
+ |onClear|() => void|-|清除回调|
82
+ |placeholder|string|-|占位符文本|
83
+ |SearchIcon|Component|-|自定义搜索图标|
84
+ |ClearIcon|Component|-|自定义清除图标|
85
+ |className|string|-|自定义样式类名|
86
+ |style|CSSProperties|-|自定义样式|
87
+ |onFocus|(e: FocusEvent) => void|-|获得焦点回调|
88
+ |onBlur|(e: FocusEvent) => void|-|失去焦点回调|
89
+ |autoFocus|boolean|false|是否自动聚焦|
90
+ |variant|VariantType|-|搜索模式|
89
91
 
90
92
  **示例**
91
93
  ``` typescript
@@ -217,21 +219,22 @@ import CustomSearchBar from './CustomSearchBar.vue';
217
219
  【自定义 SearchResults】
218
220
 
219
221
  **Props**
220
- | 属性名 | 类型 | 默认值 | 说明 |
221
- | --- | --- | --- | --- |
222
- | results | Map<SearchType, SearchResult> | - | 搜索结果数据 |
223
- | isLoading | boolean | - | 是否正在加载 |
224
- | error | Error \\| null | - | 错误信息 |
225
- | keyword | string | - | 搜索关键词 |
226
- | typeLabels | Record<SearchType, string> | - | 搜索类型标签 |
227
- | onLoadMore | (type: SearchType) => void | - | 加载更多回调 |
228
- | onResultItemClick | (data: SearchResultItemType, type: SearchType) => void | - | 结果项点击回调 |
229
- | SearchResultsLoading | Component | Loading | 自定义加载组件 |
230
- | SearchResultsPresearch | Component | - | 搜索前占位符组件 |
231
- | SearchResultsEmpty | Component | EmptyResult | 空结果占位符组件 |
232
- | SearchResultItem | Component<ResultItemProps> | DefaultSearchResultsItem | 自定义结果项组件 |
233
- | variant | VariantType | VariantType.STANDARD | 显示模式 |
234
- | searchType | SearchType \\| 'all' | 'all' | 当前搜索类型 |
222
+
223
+ |属性名|类型|默认值|说明|
224
+ |---------|---------|---------|---------|
225
+ |results|Map<SearchType, SearchResult>|-|搜索结果数据|
226
+ |isLoading|boolean|-|是否正在加载|
227
+ |error|Error \| null|-|错误信息|
228
+ |keyword|string|-|搜索关键词|
229
+ |typeLabels|Record<SearchType, string>|-|搜索类型标签|
230
+ |onLoadMore|(type: SearchType) => void|-|加载更多回调|
231
+ |onResultItemClick|(data: SearchResultItemType, type: SearchType) => void|-|结果项点击回调|
232
+ |SearchResultsLoading|Component|Loading|自定义加载组件|
233
+ |SearchResultsPresearch|Component|-|搜索前占位符组件|
234
+ |SearchResultsEmpty|Component|EmptyResult|空结果占位符组件|
235
+ |SearchResultItem|Component<ResultItemProps>|DefaultSearchResultsItem|自定义结果项组件|
236
+ |variant|VariantType|VariantType.STANDARD|显示模式|
237
+ |searchType|SearchType \| 'all'|'all'|当前搜索类型|
235
238
 
236
239
  **示例**
237
240
  ``` typescript
@@ -405,12 +408,13 @@ import CustomSearchResults from './CustomSearchResults.vue';
405
408
  【自定义 SearchAdvanced】
406
409
 
407
410
  **Props**
408
- | 属性名 | 类型 | 默认值 | 说明 |
409
- | --- | --- | --- | --- |
410
- | variant | VariantType | - | 显示模式 |
411
- | searchType | SearchTabType | - | 当前搜索类型 |
412
- | advancedParams | Map<SearchType, SearchParamsMap[SearchType]> | - | 高级搜索参数 |
413
- | onAdvancedParamsChange | (type: SearchType, params: SearchParamsMap[SearchType]) => void | - | 参数变化回调 |
411
+
412
+ |属性名|类型|默认值|说明|
413
+ |---------|---------|---------|---------|
414
+ |variant|VariantType|-|显示模式|
415
+ |searchType|SearchTabType|-|当前搜索类型|
416
+ |advancedParams|Map<SearchType, SearchParamsMap[SearchType]>|-|高级搜索参数|
417
+ |onAdvancedParamsChange|(type: SearchType, params: SearchParamsMap[SearchType]) => void|-|参数变化回调|
414
418
 
415
419
  **示例**
416
420
  ``` typescript
@@ -558,13 +562,14 @@ import CustomSearchAdvanced from './CustomSearchAdvanced.vue';
558
562
  【自定义 SearchResultItem】
559
563
 
560
564
  **Props**
561
- | 属性名 | 类型 | 默认值 | 说明 |
562
- | --- | --- | --- | --- |
563
- | data | SearchResultItem | - | 搜索结果数据 |
564
- | type | SearchType | - | 搜索结果类型 |
565
- | keyword | string | - | 搜索关键词 |
566
- | onClick | (data: SearchResultItem, type: SearchType) => void | - | 点击回调 |
567
- | className | string | - | 自定义样式类名 |
565
+
566
+ |属性名|类型|默认值|说明|
567
+ |---------|---------|---------|---------|
568
+ |data|SearchResultItem|-|搜索结果数据|
569
+ |type|SearchType|-|搜索结果类型|
570
+ |keyword|string|-|搜索关键词|
571
+ |onClick|(data: SearchResultItem, type: SearchType) => void|-|点击回调|
572
+ |className|string|-|自定义样式类名|
568
573
 
569
574
  **示例**
570
575
  ``` java
@@ -717,11 +722,12 @@ import CustomSearchItem from './CustomSearchItem.vue';
717
722
  【自定义占位符】
718
723
 
719
724
  **Props**
720
- | 属性名 | 类型 | 默认值 | 说明 |
721
- | --- | --- | --- | --- |
722
- | SearchResultsPresearch | Component | - | 搜索前占位符组件 |
723
- | SearchResultsLoading | Component | - | 加载中占位符组件 |
724
- | SearchResultsEmpty | Component | - | 空结果占位符组件 |
725
+
726
+ |属性名|类型|默认值|说明|
727
+ |---------|---------|---------|---------|
728
+ |SearchResultsPresearch|Component|-|搜索前占位符组件|
729
+ |SearchResultsLoading|Component|-|加载中占位符组件|
730
+ |SearchResultsEmpty|Component|-|空结果占位符组件|
725
731
 
726
732
  **示例**
727
733
  ``` typescript