@tencent-rtc/mcp 1.3.8 → 1.4.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 (429) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/callkit/preset/android/integration.md +430 -0
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/chatkit/android/integration.md +490 -0
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +19 -88
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/core-sdk/voice/android/voice-audience-list.md +263 -0
  90. package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +222 -0
  91. package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +452 -0
  92. package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +536 -0
  93. package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +442 -0
  94. package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +489 -0
  95. package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +574 -0
  96. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +435 -0
  97. package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
  98. package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +576 -0
  99. package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +263 -0
  100. package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +212 -0
  101. package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +404 -0
  102. package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +499 -0
  103. package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +403 -0
  104. package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +552 -0
  105. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +514 -0
  106. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +348 -0
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +173 -337
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/definitions/get_callkit_api_def.js +29 -0
  201. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  202. package/tools/definitions/get_faq_def.js +17 -18
  203. package/tools/definitions/get_faq_def.js.map +1 -1
  204. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -18
  205. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  206. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  207. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  208. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -19
  209. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  210. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  211. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  212. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  214. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  215. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  216. package/tools/definitions/get_usersig_def.js +17 -22
  217. package/tools/definitions/get_usersig_def.js.map +1 -1
  218. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  219. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  220. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  221. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  223. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  224. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  225. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  227. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  228. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  229. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  230. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -30
  231. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  232. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  233. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  234. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  235. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  240. package/tools/definitions/present_framework_choice_def.js +24 -12
  241. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  242. package/tools/index.js +47 -59
  243. package/tools/index.js.map +1 -1
  244. package/tools/live/get_native_livekit_core_features.js +65 -0
  245. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  246. package/tools/live/get_native_livekit_core_integration.js +59 -0
  247. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  248. package/tools/live/get_web_live_uikit_integration.js +48 -0
  249. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  250. package/tools/live/get_web_livekit_api.js +32 -0
  251. package/tools/live/get_web_livekit_api.js.map +1 -0
  252. package/tools/live/get_web_livekit_component_detail.js +34 -0
  253. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  254. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  255. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  256. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  257. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  258. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  259. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  260. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  261. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  264. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  265. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  266. package/utils/generate-structured-result.js +61 -17
  267. package/utils/generate-structured-result.js.map +1 -1
  268. package/utils/report-cls-client.js +12 -1
  269. package/utils/report-cls-client.js.map +1 -1
  270. package/utils/report-es-client.js +2 -2
  271. package/resource/doc/chatuikit/android/integration.md +0 -287
  272. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  273. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  274. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  275. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  276. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  277. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  278. package/resource/doc/chatuikit/react/components/search.md +0 -745
  279. package/resource/doc/chatuikit/react/create-group.md +0 -23
  280. package/resource/doc/chatuikit/react/init.md +0 -26
  281. package/resource/doc/chatuikit/react/workflow.md +0 -258
  282. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  283. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  284. package/resource/doc/chatuikit/vue/init.md +0 -40
  285. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  286. package/resource/doc/livekit/live/android/workflow.md +0 -320
  287. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  288. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  289. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  290. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  291. package/resource/doc/livekit/live/vue/faq.md +0 -0
  292. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  293. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  295. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  296. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  297. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  298. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  299. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  300. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  301. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  302. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  303. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  304. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  305. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  306. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  307. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  308. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  309. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  310. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  311. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  312. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  313. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  315. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  316. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  317. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  318. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  319. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  320. package/resource/doc/roomkit/vue/workflow.md +0 -487
  321. package/resource/doc/tuicallkit/android/integration.md +0 -286
  322. package/resource/doc/tuicallkit/android/workflow.md +0 -0
  323. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  324. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  326. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  327. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  328. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  329. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  330. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  331. package/resource/doc/tuicallkit/react/api.md +0 -1404
  332. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  333. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  334. package/tools/call/get-native-call-integration.js +0 -43
  335. package/tools/call/get-native-call-integration.js.map +0 -1
  336. package/tools/call/get-web-call-api.js +0 -27
  337. package/tools/call/get-web-call-api.js.map +0 -1
  338. package/tools/call/get-web-call-integration.js.map +0 -1
  339. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  340. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  341. package/tools/chat/get-native-chat-integration.js +0 -45
  342. package/tools/chat/get-native-chat-integration.js.map +0 -1
  343. package/tools/chat/get-web-chat-component-detail.js +0 -31
  344. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  345. package/tools/chat/get-web-chat-integration.js +0 -45
  346. package/tools/chat/get-web-chat-integration.js.map +0 -1
  347. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  348. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  349. package/tools/chat/get-web-create-group-doc.js +0 -28
  350. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  351. package/tools/common/get-faq.js +0 -91
  352. package/tools/common/get-faq.js.map +0 -1
  353. package/tools/common/get-usersig.js.map +0 -1
  354. package/tools/common/present-framework-choice.js +0 -16
  355. package/tools/common/present-framework-choice.js.map +0 -1
  356. package/tools/common/record-prompt.js +0 -55
  357. package/tools/common/record-prompt.js.map +0 -1
  358. package/tools/common/record-result.js +0 -60
  359. package/tools/common/record-result.js.map +0 -1
  360. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  361. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  362. package/tools/definitions/get_native_live_api_def.js +0 -23
  363. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  364. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  365. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -49
  367. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -74
  369. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  370. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  371. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  372. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  373. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  374. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  375. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  376. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  377. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  378. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  379. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  380. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  381. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  382. package/tools/definitions/get_web_room_feature_detail_def.js +0 -95
  383. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  385. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  386. package/tools/definitions/record_prompt_def.js +0 -53
  387. package/tools/definitions/record_prompt_def.js.map +0 -1
  388. package/tools/definitions/record_result_def.js +0 -30
  389. package/tools/definitions/record_result_def.js.map +0 -1
  390. package/tools/live/get-native-live-uikit-integration.js +0 -101
  391. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  392. package/tools/live/get-web-live-component-detail.js +0 -31
  393. package/tools/live/get-web-live-component-detail.js.map +0 -1
  394. package/tools/live/get-web-live-state-detail.js +0 -31
  395. package/tools/live/get-web-live-state-detail.js.map +0 -1
  396. package/tools/live/get-web-live-uikit-integration.js +0 -52
  397. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  398. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  399. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_interaction.js +0 -101
  401. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  402. package/tools/native_live/get-native-live-api.js +0 -31
  403. package/tools/native_live/get-native-live-api.js.map +0 -1
  404. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  405. package/tools/room/get-web-room-integration.js.map +0 -1
  406. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  407. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  408. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  409. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  411. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  413. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  415. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  417. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  418. package/tools/trtc/get-trtc-native-api.js +0 -31
  419. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  420. package/utils/handle-component-name.js +0 -33
  421. package/utils/handle-component-name.js.map +0 -1
  422. /package/resource/doc/{chatuikit/android/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  423. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  424. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  425. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  426. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  429. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -3,208 +3,35 @@
3
3
  Search is a complete search solution that includes a comprehensive component set for search box, search results display, advanced search, and more. It's suitable for user, group, and message search scenarios in instant messaging, online meetings, online education, and more.
4
4
 
5
5
  > **Note:**
6
- >
6
+ >
7
7
 
8
8
  > This feature is a value-added service that requires you to purchase the Cloud Search Plugin. Please click [Purchase](https://console.trtc.io/chat/plugin/TUICloudSearch).
9
- >
10
-
11
-
12
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/a31b2bd2870911f0bd05525400454e06.png)
13
-
9
+ >
14
10
 
15
11
  ## Search Modes
16
- <table>
17
- <tr>
18
- <td rowspan="1" colSpan="1" >**Mini Mode (MINI)**</td>
19
-
20
- <td rowspan="1" colSpan="1" >**Standard Mode (STANDARD)**</td>
21
-
22
- <td rowspan="1" colSpan="1" >**Embedded Mode (EMBEDDED)**</td>
23
- </tr>
24
-
25
- <tr>
26
- <td rowspan="1" colSpan="1" >Suitable for sidebar or small containers<br>Displays limited number of results<br>Supports expanding to view more</td>
27
-
28
- <td rowspan="1" colSpan="1" >Suitable for full-screen search interface<br>Complete feature display<br>Supports advanced search</td>
29
-
30
- <td rowspan="1" colSpan="1" >Suitable for chat interface<br>Focuses on message search<br>Optimized layout</td>
31
- </tr>
32
- </table>
33
-
12
+ | **Mini Mode (MINI)** | **Standard Mode (STANDARD)** | **Embedded Mode (EMBEDDED)** |
13
+ | --- | --- | --- |
14
+ | Suitable for sidebar or small containers<br>Displays limited number of results<br>Supports expanding to view more | Suitable for full-screen search interface<br>Complete feature display<br>Supports advanced search | Suitable for chat interface<br>Focuses on message search<br>Optimized layout |
34
15
 
35
16
  ## Props
36
- <table>
37
- <tr>
38
- <td rowspan="1" colSpan="1" >Property</td>
39
-
40
- <td rowspan="1" colSpan="1" >Type</td>
41
-
42
- <td rowspan="1" colSpan="1" >Default Value</td>
43
-
44
- <td rowspan="1" colSpan="1" >Description</td>
45
- </tr>
46
-
47
- <tr>
48
- <td rowspan="1" colSpan="1" >variant</td>
49
-
50
- <td rowspan="1" colSpan="1" >VariantType</td>
51
-
52
- <td rowspan="1" colSpan="1" >VariantType.MINI</td>
53
-
54
- <td rowspan="1" colSpan="1" >Search mode: mini (Mini), standard (Standard), embedded (Embedded)</td>
55
- </tr>
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >SearchBar</td>
59
-
60
- <td rowspan="1" colSpan="1" >Component<SearchBarProps></td>
61
-
62
- <td rowspan="1" colSpan="1" >DefaultSearchBar</td>
63
-
64
- <td rowspan="1" colSpan="1" >Custom search bar component</td>
65
- </tr>
66
-
67
- <tr>
68
- <td rowspan="1" colSpan="1" >SearchResults</td>
69
-
70
- <td rowspan="1" colSpan="1" >Component<SearchResultsProps></td>
71
-
72
- <td rowspan="1" colSpan="1" >DefaultSearchResults</td>
73
-
74
- <td rowspan="1" colSpan="1" >Custom search results component</td>
75
- </tr>
76
-
77
- <tr>
78
- <td rowspan="1" colSpan="1" >SearchAdvanced</td>
79
-
80
- <td rowspan="1" colSpan="1" >Component<SearchAdvancedProps></td>
81
-
82
- <td rowspan="1" colSpan="1" >DefaultSearchAdvanced</td>
83
-
84
- <td rowspan="1" colSpan="1" >Custom advanced search component</td>
85
- </tr>
86
-
87
- <tr>
88
- <td rowspan="1" colSpan="1" >SearchResultsPresearch</td>
89
-
90
- <td rowspan="1" colSpan="1" >Component</td>
91
-
92
- <td rowspan="1" colSpan="1" >-</td>
93
-
94
- <td rowspan="1" colSpan="1" >Pre-search placeholder component</td>
95
- </tr>
96
-
97
- <tr>
98
- <td rowspan="1" colSpan="1" >SearchResultsLoading</td>
99
-
100
- <td rowspan="1" colSpan="1" >Component</td>
101
-
102
- <td rowspan="1" colSpan="1" >-</td>
103
-
104
- <td rowspan="1" colSpan="1" >Loading placeholder component</td>
105
- </tr>
106
-
107
- <tr>
108
- <td rowspan="1" colSpan="1" >SearchResultsEmpty</td>
109
-
110
- <td rowspan="1" colSpan="1" >Component</td>
111
-
112
- <td rowspan="1" colSpan="1" >-</td>
113
-
114
- <td rowspan="1" colSpan="1" >Empty results placeholder component</td>
115
- </tr>
116
-
117
- <tr>
118
- <td rowspan="1" colSpan="1" >SearchResultItem</td>
119
-
120
- <td rowspan="1" colSpan="1" >Component<ResultItemProps></td>
121
-
122
- <td rowspan="1" colSpan="1" >-</td>
123
-
124
- <td rowspan="1" colSpan="1" >Custom search result item component</td>
125
- </tr>
126
-
127
- <tr>
128
- <td rowspan="1" colSpan="1" >debounceTime</td>
129
-
130
- <td rowspan="1" colSpan="1" >number</td>
131
-
132
- <td rowspan="1" colSpan="1" >300</td>
133
-
134
- <td rowspan="1" colSpan="1" >Search debounce time (milliseconds)</td>
135
- </tr>
136
-
137
- <tr>
138
- <td rowspan="1" colSpan="1" >autoFocus</td>
139
-
140
- <td rowspan="1" colSpan="1" >boolean</td>
141
-
142
- <td rowspan="1" colSpan="1" >false</td>
143
-
144
- <td rowspan="1" colSpan="1" >Whether to auto-focus search box</td>
145
- </tr>
146
-
147
- <tr>
148
- <td rowspan="1" colSpan="1" >className</td>
149
-
150
- <td rowspan="1" colSpan="1" >string</td>
151
-
152
- <td rowspan="1" colSpan="1" >-</td>
153
-
154
- <td rowspan="1" colSpan="1" >Custom style class name</td>
155
- </tr>
156
-
157
- <tr>
158
- <td rowspan="1" colSpan="1" >style</td>
159
-
160
- <td rowspan="1" colSpan="1" >CSSProperties</td>
161
-
162
- <td rowspan="1" colSpan="1" >-</td>
163
-
164
- <td rowspan="1" colSpan="1" >Custom styles</td>
165
- </tr>
166
-
167
- <tr>
168
- <td rowspan="1" colSpan="1" >onKeywordChange</td>
169
-
170
- <td rowspan="1" colSpan="1" >(keyword: string) => void</td>
171
-
172
- <td rowspan="1" colSpan="1" >-</td>
173
-
174
- <td rowspan="1" colSpan="1" >Search keyword change callback</td>
175
- </tr>
176
-
177
- <tr>
178
- <td rowspan="1" colSpan="1" >onSearchComplete</td>
179
-
180
- <td rowspan="1" colSpan="1" >(results: Map<SearchType, SearchResult>) => void</td>
181
-
182
- <td rowspan="1" colSpan="1" >-</td>
183
-
184
- <td rowspan="1" colSpan="1" >Search complete callback</td>
185
- </tr>
186
-
187
- <tr>
188
- <td rowspan="1" colSpan="1" >onResultItemClick</td>
189
-
190
- <td rowspan="1" colSpan="1" >(data: SearchResultItem, type: SearchType) => void</td>
191
-
192
- <td rowspan="1" colSpan="1" >-</td>
193
-
194
- <td rowspan="1" colSpan="1" >Search result click callback</td>
195
- </tr>
196
-
197
- <tr>
198
- <td rowspan="1" colSpan="1" >onError</td>
199
-
200
- <td rowspan="1" colSpan="1" >(error: Error) => void</td>
201
-
202
- <td rowspan="1" colSpan="1" >-</td>
203
-
204
- <td rowspan="1" colSpan="1" >Search error callback</td>
205
- </tr>
206
- </table>
207
-
17
+ | Property | Type | Default Value | Description |
18
+ | --- | --- | --- | --- |
19
+ | variant | VariantType | VariantType.MINI | Search mode: mini (Mini), standard (Standard), embedded (Embedded) |
20
+ | SearchBar | Component<SearchBarProps> | DefaultSearchBar | Custom search bar component |
21
+ | SearchResults | Component<SearchResultsProps> | DefaultSearchResults | Custom search results component |
22
+ | SearchAdvanced | Component<SearchAdvancedProps> | DefaultSearchAdvanced | Custom advanced search component |
23
+ | SearchResultsPresearch | Component | - | Pre-search placeholder component |
24
+ | SearchResultsLoading | Component | - | Loading placeholder component |
25
+ | SearchResultsEmpty | Component | - | Empty results placeholder component |
26
+ | SearchResultItem | Component<ResultItemProps> | - | Custom search result item component |
27
+ | debounceTime | number | 300 | Search debounce time (milliseconds) |
28
+ | autoFocus | boolean | false | Whether to auto-focus search box |
29
+ | className | string | - | Custom style class name |
30
+ | style | CSSProperties | - | Custom styles |
31
+ | onKeywordChange | (keyword: string) => void | - | Search keyword change callback |
32
+ | onSearchComplete | (results: Map<SearchType, SearchResult>) => void | - | Search complete callback |
33
+ | onResultItemClick | (data: SearchResultItem, type: SearchType) => void | - | Search result click callback |
34
+ | onError | (error: Error) => void | - | Search error callback |
208
35
 
209
36
  ## Basic Usage
210
37
  ``` typescript
@@ -241,153 +68,24 @@ const handleError = (error: Error) => {
241
68
 
242
69
  The `Search` component provides multiple replaceable child components, allowing users to customize `SearchBar`, `SearchResults`, `SearchAdvanced`, `SearchResultItem`, `SearchResultsPresearch`, `SearchResultsLoading`, `SearchResultsEmpty`, etc. Users can also utilize default child components for further customization.
243
70
 
244
-
245
-
246
71
  【Custom SearchBar】
247
72
 
248
73
  **Props**
249
- <table>
250
- <tr>
251
- <td rowspan="1" colSpan="1" >Property</td>
252
-
253
- <td rowspan="1" colSpan="1" >Type</td>
254
-
255
- <td rowspan="1" colSpan="1" >Default Value</td>
256
-
257
- <td rowspan="1" colSpan="1" >Description</td>
258
- </tr>
259
-
260
- <tr>
261
- <td rowspan="1" colSpan="1" >value</td>
262
-
263
- <td rowspan="1" colSpan="1" >string</td>
264
-
265
- <td rowspan="1" colSpan="1" >-</td>
266
-
267
- <td rowspan="1" colSpan="1" >Search box value</td>
268
- </tr>
269
-
270
- <tr>
271
- <td rowspan="1" colSpan="1" >onChange</td>
272
-
273
- <td rowspan="1" colSpan="1" >(e: Event) => void</td>
274
-
275
- <td rowspan="1" colSpan="1" >-</td>
276
-
277
- <td rowspan="1" colSpan="1" >Input change callback</td>
278
- </tr>
279
-
280
- <tr>
281
- <td rowspan="1" colSpan="1" >onKeyDown</td>
282
-
283
- <td rowspan="1" colSpan="1" >(e: KeyboardEvent) => void</td>
284
-
285
- <td rowspan="1" colSpan="1" >-</td>
286
-
287
- <td rowspan="1" colSpan="1" >Keyboard event callback</td>
288
- </tr>
289
-
290
- <tr>
291
- <td rowspan="1" colSpan="1" >onClear</td>
292
-
293
- <td rowspan="1" colSpan="1" >() => void</td>
294
-
295
- <td rowspan="1" colSpan="1" >-</td>
296
-
297
- <td rowspan="1" colSpan="1" >Clear callback</td>
298
- </tr>
299
-
300
- <tr>
301
- <td rowspan="1" colSpan="1" >placeholder</td>
302
-
303
- <td rowspan="1" colSpan="1" >string</td>
304
-
305
- <td rowspan="1" colSpan="1" >-</td>
306
-
307
- <td rowspan="1" colSpan="1" >Placeholder text</td>
308
- </tr>
309
-
310
- <tr>
311
- <td rowspan="1" colSpan="1" >SearchIcon</td>
312
-
313
- <td rowspan="1" colSpan="1" >Component</td>
314
-
315
- <td rowspan="1" colSpan="1" >-</td>
316
-
317
- <td rowspan="1" colSpan="1" >Custom search icon</td>
318
- </tr>
319
-
320
- <tr>
321
- <td rowspan="1" colSpan="1" >ClearIcon</td>
322
-
323
- <td rowspan="1" colSpan="1" >Component</td>
324
-
325
- <td rowspan="1" colSpan="1" >-</td>
326
-
327
- <td rowspan="1" colSpan="1" >Custom clear icon</td>
328
- </tr>
329
-
330
- <tr>
331
- <td rowspan="1" colSpan="1" >className</td>
332
-
333
- <td rowspan="1" colSpan="1" >string</td>
334
-
335
- <td rowspan="1" colSpan="1" >-</td>
336
-
337
- <td rowspan="1" colSpan="1" >Custom style class name</td>
338
- </tr>
339
-
340
- <tr>
341
- <td rowspan="1" colSpan="1" >style</td>
342
-
343
- <td rowspan="1" colSpan="1" >CSSProperties</td>
344
-
345
- <td rowspan="1" colSpan="1" >-</td>
346
-
347
- <td rowspan="1" colSpan="1" >Custom styles</td>
348
- </tr>
349
-
350
- <tr>
351
- <td rowspan="1" colSpan="1" >onFocus</td>
352
-
353
- <td rowspan="1" colSpan="1" >(e: FocusEvent) => void</td>
354
-
355
- <td rowspan="1" colSpan="1" >-</td>
356
-
357
- <td rowspan="1" colSpan="1" >Focus callback</td>
358
- </tr>
359
-
360
- <tr>
361
- <td rowspan="1" colSpan="1" >onBlur</td>
362
-
363
- <td rowspan="1" colSpan="1" >(e: FocusEvent) => void</td>
364
-
365
- <td rowspan="1" colSpan="1" >-</td>
366
-
367
- <td rowspan="1" colSpan="1" >Blur callback</td>
368
- </tr>
369
-
370
- <tr>
371
- <td rowspan="1" colSpan="1" >autoFocus</td>
372
-
373
- <td rowspan="1" colSpan="1" >boolean</td>
374
-
375
- <td rowspan="1" colSpan="1" >false</td>
376
-
377
- <td rowspan="1" colSpan="1" >Whether to auto-focus</td>
378
- </tr>
379
-
380
- <tr>
381
- <td rowspan="1" colSpan="1" >variant</td>
382
-
383
- <td rowspan="1" colSpan="1" >VariantType</td>
384
-
385
- <td rowspan="1" colSpan="1" >-</td>
386
-
387
- <td rowspan="1" colSpan="1" >Search mode</td>
388
- </tr>
389
- </table>
390
-
74
+ | Property | Type | Default Value | Description |
75
+ | --- | --- | --- | --- |
76
+ | value | string | - | Search box value |
77
+ | onChange | (e: Event) => void | - | Input change callback |
78
+ | onKeyDown | (e: KeyboardEvent) => void | - | Keyboard event callback |
79
+ | onClear | () => void | - | Clear callback |
80
+ | placeholder | string | - | Placeholder text |
81
+ | SearchIcon | Component | - | Custom search icon |
82
+ | ClearIcon | Component | - | Custom clear icon |
83
+ | className | string | - | Custom style class name |
84
+ | style | CSSProperties | - | Custom styles |
85
+ | onFocus | (e: FocusEvent) => void | - | Focus callback |
86
+ | onBlur | (e: FocusEvent) => void | - | Blur callback |
87
+ | autoFocus | boolean | false | Whether to auto-focus |
88
+ | variant | VariantType | - | Search mode |
391
89
 
392
90
  **Example**
393
91
  ``` typescript
@@ -519,148 +217,21 @@ import CustomSearchBar from './CustomSearchBar.vue';
519
217
  【Custom SearchResults】
520
218
 
521
219
  **Props**
522
- <table>
523
- <tr>
524
- <td rowspan="1" colSpan="1" >Property</td>
525
-
526
- <td rowspan="1" colSpan="1" >Type</td>
527
-
528
- <td rowspan="1" colSpan="1" >Default Value</td>
529
-
530
- <td rowspan="1" colSpan="1" >Description</td>
531
- </tr>
532
-
533
- <tr>
534
- <td rowspan="1" colSpan="1" >results</td>
535
-
536
- <td rowspan="1" colSpan="1" >Map<SearchType, SearchResult></td>
537
-
538
- <td rowspan="1" colSpan="1" >-</td>
539
-
540
- <td rowspan="1" colSpan="1" >Search result data</td>
541
- </tr>
542
-
543
- <tr>
544
- <td rowspan="1" colSpan="1" >isLoading</td>
545
-
546
- <td rowspan="1" colSpan="1" >boolean</td>
547
-
548
- <td rowspan="1" colSpan="1" >-</td>
549
-
550
- <td rowspan="1" colSpan="1" >Whether loading</td>
551
- </tr>
552
-
553
- <tr>
554
- <td rowspan="1" colSpan="1" >error</td>
555
-
556
- <td rowspan="1" colSpan="1" >Error \| null</td>
557
-
558
- <td rowspan="1" colSpan="1" >-</td>
559
-
560
- <td rowspan="1" colSpan="1" >Error information</td>
561
- </tr>
562
-
563
- <tr>
564
- <td rowspan="1" colSpan="1" >keyword</td>
565
-
566
- <td rowspan="1" colSpan="1" >string</td>
567
-
568
- <td rowspan="1" colSpan="1" >-</td>
569
-
570
- <td rowspan="1" colSpan="1" >Search keyword</td>
571
- </tr>
572
-
573
- <tr>
574
- <td rowspan="1" colSpan="1" >typeLabels</td>
575
-
576
- <td rowspan="1" colSpan="1" >Record<SearchType, string></td>
577
-
578
- <td rowspan="1" colSpan="1" >-</td>
579
-
580
- <td rowspan="1" colSpan="1" >Search type labels</td>
581
- </tr>
582
-
583
- <tr>
584
- <td rowspan="1" colSpan="1" >onLoadMore</td>
585
-
586
- <td rowspan="1" colSpan="1" >(type: SearchType) => void</td>
587
-
588
- <td rowspan="1" colSpan="1" >-</td>
589
-
590
- <td rowspan="1" colSpan="1" >Load more callback</td>
591
- </tr>
592
-
593
- <tr>
594
- <td rowspan="1" colSpan="1" >onResultItemClick</td>
595
-
596
- <td rowspan="1" colSpan="1" >(data: SearchResultItemType, type: SearchType) => void</td>
597
-
598
- <td rowspan="1" colSpan="1" >-</td>
599
-
600
- <td rowspan="1" colSpan="1" >Result item click callback</td>
601
- </tr>
602
-
603
- <tr>
604
- <td rowspan="1" colSpan="1" >SearchResultsLoading</td>
605
-
606
- <td rowspan="1" colSpan="1" >Component</td>
607
-
608
- <td rowspan="1" colSpan="1" >Loading</td>
609
-
610
- <td rowspan="1" colSpan="1" >Custom loading component</td>
611
- </tr>
612
-
613
- <tr>
614
- <td rowspan="1" colSpan="1" >SearchResultsPresearch</td>
615
-
616
- <td rowspan="1" colSpan="1" >Component</td>
617
-
618
- <td rowspan="1" colSpan="1" >-</td>
619
-
620
- <td rowspan="1" colSpan="1" >Pre-search placeholder component</td>
621
- </tr>
622
-
623
- <tr>
624
- <td rowspan="1" colSpan="1" >SearchResultsEmpty</td>
625
-
626
- <td rowspan="1" colSpan="1" >Component</td>
627
-
628
- <td rowspan="1" colSpan="1" >EmptyResult</td>
629
-
630
- <td rowspan="1" colSpan="1" >Empty results placeholder component</td>
631
- </tr>
632
-
633
- <tr>
634
- <td rowspan="1" colSpan="1" >SearchResultItem</td>
635
-
636
- <td rowspan="1" colSpan="1" >Component<ResultItemProps></td>
637
-
638
- <td rowspan="1" colSpan="1" >DefaultSearchResultsItem</td>
639
-
640
- <td rowspan="1" colSpan="1" >Custom result item component</td>
641
- </tr>
642
-
643
- <tr>
644
- <td rowspan="1" colSpan="1" >variant</td>
645
-
646
- <td rowspan="1" colSpan="1" >VariantType</td>
647
-
648
- <td rowspan="1" colSpan="1" >VariantType.STANDARD</td>
649
-
650
- <td rowspan="1" colSpan="1" >Display mode</td>
651
- </tr>
652
-
653
- <tr>
654
- <td rowspan="1" colSpan="1" >searchType</td>
655
-
656
- <td rowspan="1" colSpan="1" >SearchType \| 'all'</td>
657
-
658
- <td rowspan="1" colSpan="1" >'all'</td>
659
-
660
- <td rowspan="1" colSpan="1" >Current search type</td>
661
- </tr>
662
- </table>
663
-
220
+ | Property | Type | Default Value | Description |
221
+ | --- | --- | --- | --- |
222
+ | results | Map<SearchType, SearchResult> | - | Search result data |
223
+ | isLoading | boolean | - | Whether loading |
224
+ | error | Error \\| null | - | Error information |
225
+ | keyword | string | - | Search keyword |
226
+ | typeLabels | Record<SearchType, string> | - | Search type labels |
227
+ | onLoadMore | (type: SearchType) => void | - | Load more callback |
228
+ | onResultItemClick | (data: SearchResultItemType, type: SearchType) => void | - | Result item click callback |
229
+ | SearchResultsLoading | Component | Loading | Custom loading component |
230
+ | SearchResultsPresearch | Component | - | Pre-search placeholder component |
231
+ | SearchResultsEmpty | Component | EmptyResult | Empty results placeholder component |
232
+ | SearchResultItem | Component<ResultItemProps> | DefaultSearchResultsItem | Custom result item component |
233
+ | variant | VariantType | VariantType.STANDARD | Display mode |
234
+ | searchType | SearchType \\| 'all' | 'all' | Current search type |
664
235
 
665
236
  **Example**
666
237
  ``` typescript
@@ -709,7 +280,7 @@ import CustomSearchBar from './CustomSearchBar.vue';
709
280
  :key="index"
710
281
  @click="handleResultClick(data)"
711
282
  >
712
- {{ (data as SearchCloudGroupsResultItem).groupInfo.name
283
+ {{ (data as SearchCloudGroupsResultItem).groupInfo.name
713
284
  || (data as SearchCloudGroupsResultItem).groupInfo.groupID }}
714
285
  </li>
715
286
  </ul>
@@ -834,58 +405,12 @@ import CustomSearchResults from './CustomSearchResults.vue';
834
405
  【Custom SearchAdvanced】
835
406
 
836
407
  **Props**
837
- <table>
838
- <tr>
839
- <td rowspan="1" colSpan="1" >Property</td>
840
-
841
- <td rowspan="1" colSpan="1" >Type</td>
842
-
843
- <td rowspan="1" colSpan="1" >Default Value</td>
844
-
845
- <td rowspan="1" colSpan="1" >Description</td>
846
- </tr>
847
-
848
- <tr>
849
- <td rowspan="1" colSpan="1" >variant</td>
850
-
851
- <td rowspan="1" colSpan="1" >VariantType</td>
852
-
853
- <td rowspan="1" colSpan="1" >-</td>
854
-
855
- <td rowspan="1" colSpan="1" >Display mode</td>
856
- </tr>
857
-
858
- <tr>
859
- <td rowspan="1" colSpan="1" >searchType</td>
860
-
861
- <td rowspan="1" colSpan="1" >SearchTabType</td>
862
-
863
- <td rowspan="1" colSpan="1" >-</td>
864
-
865
- <td rowspan="1" colSpan="1" >Current search type</td>
866
- </tr>
867
-
868
- <tr>
869
- <td rowspan="1" colSpan="1" >advancedParams</td>
870
-
871
- <td rowspan="1" colSpan="1" >Map<SearchType, SearchParamsMap[SearchType]></td>
872
-
873
- <td rowspan="1" colSpan="1" >-</td>
874
-
875
- <td rowspan="1" colSpan="1" >Advanced search parameters</td>
876
- </tr>
877
-
878
- <tr>
879
- <td rowspan="1" colSpan="1" >onAdvancedParamsChange</td>
880
-
881
- <td rowspan="1" colSpan="1" >(type: SearchType, params: SearchParamsMap[SearchType]) => void</td>
882
-
883
- <td rowspan="1" colSpan="1" >-</td>
884
-
885
- <td rowspan="1" colSpan="1" >Parameter change callback</td>
886
- </tr>
887
- </table>
888
-
408
+ | Property | Type | Default Value | Description |
409
+ | --- | --- | --- | --- |
410
+ | variant | VariantType | - | Display mode |
411
+ | searchType | SearchTabType | - | Current search type |
412
+ | advancedParams | Map<SearchType, SearchParamsMap[SearchType]> | - | Advanced search parameters |
413
+ | onAdvancedParamsChange | (type: SearchType, params: SearchParamsMap[SearchType]) => void | - | Parameter change callback |
889
414
 
890
415
  **Example**
891
416
  ``` typescript
@@ -1033,68 +558,13 @@ import CustomSearchAdvanced from './CustomSearchAdvanced.vue';
1033
558
  【Custom SearchResultItem】
1034
559
 
1035
560
  **Props**
1036
- <table>
1037
- <tr>
1038
- <td rowspan="1" colSpan="1" >Property</td>
1039
-
1040
- <td rowspan="1" colSpan="1" >Type</td>
1041
-
1042
- <td rowspan="1" colSpan="1" >Default Value</td>
1043
-
1044
- <td rowspan="1" colSpan="1" >Description</td>
1045
- </tr>
1046
-
1047
- <tr>
1048
- <td rowspan="1" colSpan="1" >data</td>
1049
-
1050
- <td rowspan="1" colSpan="1" >SearchResultItem</td>
1051
-
1052
- <td rowspan="1" colSpan="1" >-</td>
1053
-
1054
- <td rowspan="1" colSpan="1" >Search result data</td>
1055
- </tr>
1056
-
1057
- <tr>
1058
- <td rowspan="1" colSpan="1" >type</td>
1059
-
1060
- <td rowspan="1" colSpan="1" >SearchType</td>
1061
-
1062
- <td rowspan="1" colSpan="1" >-</td>
1063
-
1064
- <td rowspan="1" colSpan="1" >Search result type</td>
1065
- </tr>
1066
-
1067
- <tr>
1068
- <td rowspan="1" colSpan="1" >keyword</td>
1069
-
1070
- <td rowspan="1" colSpan="1" >string</td>
1071
-
1072
- <td rowspan="1" colSpan="1" >-</td>
1073
-
1074
- <td rowspan="1" colSpan="1" >Search keyword</td>
1075
- </tr>
1076
-
1077
- <tr>
1078
- <td rowspan="1" colSpan="1" >onClick</td>
1079
-
1080
- <td rowspan="1" colSpan="1" >(data: SearchResultItem, type: SearchType) => void</td>
1081
-
1082
- <td rowspan="1" colSpan="1" >-</td>
1083
-
1084
- <td rowspan="1" colSpan="1" >Click callback</td>
1085
- </tr>
1086
-
1087
- <tr>
1088
- <td rowspan="1" colSpan="1" >className</td>
1089
-
1090
- <td rowspan="1" colSpan="1" >string</td>
1091
-
1092
- <td rowspan="1" colSpan="1" >-</td>
1093
-
1094
- <td rowspan="1" colSpan="1" >Custom style class name</td>
1095
- </tr>
1096
- </table>
1097
-
561
+ | Property | Type | Default Value | Description |
562
+ | --- | --- | --- | --- |
563
+ | data | SearchResultItem | - | Search result data |
564
+ | type | SearchType | - | Search result type |
565
+ | keyword | string | - | Search keyword |
566
+ | onClick | (data: SearchResultItem, type: SearchType) => void | - | Click callback |
567
+ | className | string | - | Custom style class name |
1098
568
 
1099
569
  **Example**
1100
570
  ``` java
@@ -1106,7 +576,7 @@ import CustomSearchAdvanced from './CustomSearchAdvanced.vue';
1106
576
  @click="handleClick"
1107
577
  >
1108
578
  <div class="user-avatar">
1109
- <img :src="data.profile.avatar" :alt="data.profile.nick" />
579
+
1110
580
  </div>
1111
581
  <div class="user-info">
1112
582
  <div class="user-name">{{ data.profile.nick }}</div>
@@ -1247,48 +717,11 @@ import CustomSearchItem from './CustomSearchItem.vue';
1247
717
  【Custom Placeholders】
1248
718
 
1249
719
  **Props**
1250
- <table>
1251
- <tr>
1252
- <td rowspan="1" colSpan="1" >Property</td>
1253
-
1254
- <td rowspan="1" colSpan="1" >Type</td>
1255
-
1256
- <td rowspan="1" colSpan="1" >Default Value</td>
1257
-
1258
- <td rowspan="1" colSpan="1" >Description</td>
1259
- </tr>
1260
-
1261
- <tr>
1262
- <td rowspan="1" colSpan="1" >SearchResultsPresearch</td>
1263
-
1264
- <td rowspan="1" colSpan="1" >Component</td>
1265
-
1266
- <td rowspan="1" colSpan="1" >-</td>
1267
-
1268
- <td rowspan="1" colSpan="1" >Pre-search placeholder component</td>
1269
- </tr>
1270
-
1271
- <tr>
1272
- <td rowspan="1" colSpan="1" >SearchResultsLoading</td>
1273
-
1274
- <td rowspan="1" colSpan="1" >Component</td>
1275
-
1276
- <td rowspan="1" colSpan="1" >-</td>
1277
-
1278
- <td rowspan="1" colSpan="1" >Loading placeholder component</td>
1279
- </tr>
1280
-
1281
- <tr>
1282
- <td rowspan="1" colSpan="1" >SearchResultsEmpty</td>
1283
-
1284
- <td rowspan="1" colSpan="1" >Component</td>
1285
-
1286
- <td rowspan="1" colSpan="1" >-</td>
1287
-
1288
- <td rowspan="1" colSpan="1" >Empty results placeholder component</td>
1289
- </tr>
1290
- </table>
1291
-
720
+ | Property | Type | Default Value | Description |
721
+ | --- | --- | --- | --- |
722
+ | SearchResultsPresearch | Component | - | Pre-search placeholder component |
723
+ | SearchResultsLoading | Component | - | Loading placeholder component |
724
+ | SearchResultsEmpty | Component | - | Empty results placeholder component |
1292
725
 
1293
726
  **Example**
1294
727
  ``` typescript