@tencentcloud/sdk-mcp 1.3.9 → 1.4.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 (514) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/common/record_skill_session.js +58 -0
  275. package/tools/common/record_skill_session.js.map +1 -0
  276. package/tools/definitions/get_callkit_api_def.js +28 -0
  277. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  278. package/tools/definitions/get_faq_def.js +18 -19
  279. package/tools/definitions/get_faq_def.js.map +1 -1
  280. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  281. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  282. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  283. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  284. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  285. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  286. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  288. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  289. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  290. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  291. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  292. package/tools/definitions/get_usersig_def.js +17 -24
  293. package/tools/definitions/get_usersig_def.js.map +1 -1
  294. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  295. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  297. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  298. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  299. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  301. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  302. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  303. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  304. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  305. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  306. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  307. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  308. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  309. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  314. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  315. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  316. package/tools/definitions/present_framework_choice_def.js +23 -12
  317. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  318. package/tools/definitions/record_skill_session_def.js +31 -0
  319. package/tools/definitions/record_skill_session_def.js.map +1 -0
  320. package/tools/index.js +49 -61
  321. package/tools/index.js.map +1 -1
  322. package/tools/live/get_native_livekit_core_features.js +65 -0
  323. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  324. package/tools/live/get_native_livekit_core_integration.js +59 -0
  325. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  326. package/tools/live/get_web_live_uikit_integration.js +48 -0
  327. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  328. package/tools/live/get_web_livekit_api.js +32 -0
  329. package/tools/live/get_web_livekit_api.js.map +1 -0
  330. package/tools/live/get_web_livekit_component_detail.js +34 -0
  331. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  332. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  333. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  334. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  335. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  338. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  339. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  340. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  341. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  342. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  343. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  344. package/utils/generate-structured-result.js +61 -17
  345. package/utils/generate-structured-result.js.map +1 -1
  346. package/utils/report-cls-client.js +21 -1
  347. package/utils/report-cls-client.js.map +1 -1
  348. package/utils/report-es-client.js +1 -1
  349. package/resource/doc/chatuikit/android/workflow.md +0 -713
  350. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  351. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  352. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  353. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  354. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  355. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  356. package/resource/doc/chatuikit/react/components/search.md +0 -885
  357. package/resource/doc/chatuikit/react/create-group.md +0 -22
  358. package/resource/doc/chatuikit/react/init.md +0 -25
  359. package/resource/doc/chatuikit/react/workflow.md +0 -254
  360. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  361. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  362. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  363. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  364. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  365. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  366. package/resource/doc/chatuikit/vue/init.md +0 -35
  367. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  368. package/resource/doc/livekit/live/android/workflow.md +0 -322
  369. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  370. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  371. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  372. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  373. package/resource/doc/livekit/live/vue/faq.md +0 -0
  374. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  375. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  376. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  377. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  378. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  379. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  380. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  381. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  382. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  383. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  384. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  385. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  386. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  387. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  388. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  389. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  390. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  391. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  392. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  393. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  394. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  395. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  396. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  397. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  398. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  399. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  400. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  401. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  402. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  403. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  404. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  405. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  406. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  407. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  408. package/resource/doc/roomkit/vue/workflow.md +0 -733
  409. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  410. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  411. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  412. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  413. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  414. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  415. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  416. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  417. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  418. package/resource/doc/tuicallkit/react/api.md +0 -1512
  419. package/resource/doc/tuicallkit/react/faq.md +0 -986
  420. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  421. package/tools/call/get-native-call-integration.js +0 -43
  422. package/tools/call/get-native-call-integration.js.map +0 -1
  423. package/tools/call/get-web-call-api.js +0 -27
  424. package/tools/call/get-web-call-api.js.map +0 -1
  425. package/tools/call/get-web-call-integration.js.map +0 -1
  426. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  427. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  428. package/tools/chat/get-native-chat-integration.js +0 -45
  429. package/tools/chat/get-native-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-component-detail.js +0 -31
  431. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  432. package/tools/chat/get-web-chat-integration.js +0 -45
  433. package/tools/chat/get-web-chat-integration.js.map +0 -1
  434. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  435. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  436. package/tools/chat/get-web-create-group-doc.js +0 -28
  437. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  438. package/tools/common/get-faq.js +0 -91
  439. package/tools/common/get-faq.js.map +0 -1
  440. package/tools/common/get-usersig.js.map +0 -1
  441. package/tools/common/present-framework-choice.js +0 -16
  442. package/tools/common/present-framework-choice.js.map +0 -1
  443. package/tools/common/present-scenario-choice.js +0 -16
  444. package/tools/common/present-scenario-choice.js.map +0 -1
  445. package/tools/common/record-prompt.js +0 -55
  446. package/tools/common/record-prompt.js.map +0 -1
  447. package/tools/common/record-result.js +0 -60
  448. package/tools/common/record-result.js.map +0 -1
  449. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  450. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_api_def.js +0 -22
  452. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  454. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  455. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  456. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  457. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  458. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  459. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  460. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  461. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  462. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  463. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  464. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  465. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  466. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  467. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  468. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  469. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  470. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  471. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  472. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  473. package/tools/definitions/present_scenario_choice_def.js +0 -53
  474. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  475. package/tools/definitions/record_prompt_def.js +0 -58
  476. package/tools/definitions/record_prompt_def.js.map +0 -1
  477. package/tools/definitions/record_result_def.js +0 -46
  478. package/tools/definitions/record_result_def.js.map +0 -1
  479. package/tools/live/get-native-live-uikit-integration.js +0 -177
  480. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  481. package/tools/live/get-web-live-component-detail.js +0 -31
  482. package/tools/live/get-web-live-component-detail.js.map +0 -1
  483. package/tools/live/get-web-live-state-detail.js +0 -31
  484. package/tools/live/get-web-live-state-detail.js.map +0 -1
  485. package/tools/live/get-web-live-uikit-integration.js +0 -52
  486. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  487. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  488. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  489. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  490. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  491. package/tools/native_live/get-native-live-api.js +0 -31
  492. package/tools/native_live/get-native-live-api.js.map +0 -1
  493. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  494. package/tools/room/get-web-room-integration.js.map +0 -1
  495. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  496. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  498. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  500. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  502. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  503. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  504. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  505. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  506. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  507. package/tools/trtc/get-trtc-native-api.js +0 -31
  508. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  509. package/utils/handle-component-name.js +0 -33
  510. package/utils/handle-component-name.js.map +0 -1
  511. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  512. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  513. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  514. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -2,408 +2,50 @@
2
2
 
3
3
  ContactList 是一个高度可配置的联系人列表组件。该组件支持好友列表、群组列表、黑名单和申请管理,提供分组折叠、搜索过滤、自定义渲染等核心功能,适用于即时通讯、社交应用等场景的联系人管理界面。
4
4
 
5
-
6
-
7
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/1301c6bb66dd11f09a9d52540044a08e.png)
8
-
9
-
10
- ## ContactList Props
11
- <table>
12
- <tr>
13
- <td rowspan="1" colSpan="1" >字段</td>
14
-
15
- <td rowspan="1" colSpan="1" >类型</td>
16
-
17
- <td rowspan="1" colSpan="1" >默认值</td>
18
-
19
- <td rowspan="1" colSpan="1" >描述</td>
20
- </tr>
21
-
22
- <tr>
23
- <td rowspan="1" colSpan="1" >activeContactItem</td>
24
-
25
- <td rowspan="1" colSpan="1" >ContactGroupItem \| undefined</td>
26
-
27
- <td rowspan="1" colSpan="1" >`undefined`</td>
28
-
29
- <td rowspan="1" colSpan="1" >当前激活的联系人项</td>
30
- </tr>
31
-
32
- <tr>
33
- <td rowspan="1" colSpan="1" >enableSearch</td>
34
-
35
- <td rowspan="1" colSpan="1" >boolean</td>
36
-
37
- <td rowspan="1" colSpan="1" >`true`</td>
38
-
39
- <td rowspan="1" colSpan="1" >是否启用搜索功能</td>
40
- </tr>
41
-
42
- <tr>
43
- <td rowspan="1" colSpan="1" >groupConfig</td>
44
-
45
- <td rowspan="1" colSpan="1" >Partial<Record<ContactItemType, CustomGroupConfig>></td>
46
-
47
- <td rowspan="1" colSpan="1" >`{}`</td>
48
-
49
- <td rowspan="1" colSpan="1" >自定义分组配置</td>
50
- </tr>
51
-
52
- <tr>
53
- <td rowspan="1" colSpan="1" >className</td>
54
-
55
- <td rowspan="1" colSpan="1" >string</td>
56
-
57
- <td rowspan="1" colSpan="1" >`undefined`</td>
58
-
59
- <td rowspan="1" colSpan="1" >自定义 CSS 类名</td>
60
- </tr>
61
-
62
- <tr>
63
- <td rowspan="1" colSpan="1" >style</td>
64
-
65
- <td rowspan="1" colSpan="1" >React.CSSProperties</td>
66
-
67
- <td rowspan="1" colSpan="1" >`undefined`</td>
68
-
69
- <td rowspan="1" colSpan="1" >自定义内联样式</td>
70
- </tr>
71
-
72
- <tr>
73
- <td rowspan="1" colSpan="1" >searchPlaceholder</td>
74
-
75
- <td rowspan="1" colSpan="1" >string</td>
76
-
77
- <td rowspan="1" colSpan="1" >`'Search contacts'`</td>
78
-
79
- <td rowspan="1" colSpan="1" >搜索框占位符文本</td>
80
- </tr>
81
-
82
- <tr>
83
- <td rowspan="1" colSpan="1" >emptyText</td>
84
-
85
- <td rowspan="1" colSpan="1" >string</td>
86
-
87
- <td rowspan="1" colSpan="1" >`'No contacts'`</td>
88
-
89
- <td rowspan="1" colSpan="1" >空状态提示文本</td>
90
- </tr>
91
-
92
- <tr>
93
- <td rowspan="1" colSpan="1" >ContactItem</td>
94
-
95
- <td rowspan="1" colSpan="1" >React.ComponentType<ContactListItemProps> \| undefined</td>
96
-
97
- <td rowspan="1" colSpan="1" >`ContactListItem`</td>
98
-
99
- <td rowspan="1" colSpan="1" >自定义联系人项组件</td>
100
- </tr>
101
-
102
- <tr>
103
- <td rowspan="1" colSpan="1" >ContactSearchComponent</td>
104
-
105
- <td rowspan="1" colSpan="1" >React.ComponentType<ContactSearchProps> \| undefined</td>
106
-
107
- <td rowspan="1" colSpan="1" >`ContactSearch`</td>
108
-
109
- <td rowspan="1" colSpan="1" >自定义搜索组件</td>
110
- </tr>
111
-
112
- <tr>
113
- <td rowspan="1" colSpan="1" >GroupHeader</td>
114
-
115
- <td rowspan="1" colSpan="1" >React.ComponentType<{ data: ContactGroup }> \| undefined</td>
116
-
117
- <td rowspan="1" colSpan="1" >默认分组头</td>
118
-
119
- <td rowspan="1" colSpan="1" >自定义分组头部组件</td>
120
- </tr>
121
-
122
- <tr>
123
- <td rowspan="1" colSpan="1" >PlaceholderEmptyList</td>
124
-
125
- <td rowspan="1" colSpan="1" >React.ReactNode \| undefined</td>
126
-
127
- <td rowspan="1" colSpan="1" >默认空状态</td>
128
-
129
- <td rowspan="1" colSpan="1" >自定义空状态组件</td>
130
- </tr>
131
-
132
- <tr>
133
- <td rowspan="1" colSpan="1" >onContactItemClick</td>
134
-
135
- <td rowspan="1" colSpan="1" >(item: ContactGroupItem) => void</td>
136
-
137
- <td rowspan="1" colSpan="1" >`undefined`</td>
138
-
139
- <td rowspan="1" colSpan="1" >联系人项点击事件</td>
140
- </tr>
141
-
142
- <tr>
143
- <td rowspan="1" colSpan="1" >onFriendApplicationAction</td>
144
-
145
- <td rowspan="1" colSpan="1" >(action: 'accept' \| 'refuse', application: FriendApplication) => void</td>
146
-
147
- <td rowspan="1" colSpan="1" >`undefined`</td>
148
-
149
- <td rowspan="1" colSpan="1" >好友申请操作事件</td>
150
- </tr>
151
-
152
- <tr>
153
- <td rowspan="1" colSpan="1" >onGroupApplicationAction</td>
154
-
155
- <td rowspan="1" colSpan="1" >(action: 'accept' \| 'refuse', application: GroupApplication) => void</td>
156
-
157
- <td rowspan="1" colSpan="1" >`undefined`</td>
158
-
159
- <td rowspan="1" colSpan="1" >群组申请操作事件</td>
160
- </tr>
161
- </table>
162
-
5
+ ## ContactList Props
6
+ | 字段 | 类型 | 默认值 | 描述 |
7
+ | --- | --- | --- | --- |
8
+ | activeContactItem | ContactGroupItem \\| undefined | `undefined` | 当前激活的联系人项 |
9
+ | enableSearch | boolean | `true` | 是否启用搜索功能 |
10
+ | groupConfig | Partial<Record<ContactItemType, CustomGroupConfig>> | `{}` | 自定义分组配置 |
11
+ | className | string | `undefined` | 自定义 CSS 类名 |
12
+ | style | React.CSSProperties | `undefined` | 自定义内联样式 |
13
+ | searchPlaceholder | string | `'Search contacts'` | 搜索框占位符文本 |
14
+ | emptyText | string | `'No contacts'` | 空状态提示文本 |
15
+ | ContactItem | React.ComponentType<ContactListItemProps> \\| undefined | `ContactListItem` | 自定义联系人项组件 |
16
+ | ContactSearchComponent | React.ComponentType<ContactSearchProps> \\| undefined | `ContactSearch` | 自定义搜索组件 |
17
+ | GroupHeader | React.ComponentType<{ data: ContactGroup }> \\| undefined | 默认分组头 | 自定义分组头部组件 |
18
+ | PlaceholderEmptyList | React.ReactNode \\| undefined | 默认空状态 | 自定义空状态组件 |
19
+ | onContactItemClick | (item: ContactGroupItem) => void | `undefined` | 联系人项点击事件 |
20
+ | onFriendApplicationAction | (action: 'accept' \\| 'refuse', application: FriendApplication) => void | `undefined` | 好友申请操作事件 |
21
+ | onGroupApplicationAction | (action: 'accept' \\| 'refuse', application: GroupApplication) => void | `undefined` | 群组申请操作事件 |
163
22
 
164
23
  ## ContactInfo props
165
- <table>
166
- <tr>
167
- <td rowspan="1" colSpan="1" >字段</td>
168
-
169
- <td rowspan="1" colSpan="1" >类型</td>
170
-
171
- <td rowspan="1" colSpan="1" >默认值</td>
172
-
173
- <td rowspan="1" colSpan="1" >描述</td>
174
- </tr>
175
-
176
- <tr>
177
- <td rowspan="1" colSpan="1" >contactItem</td>
178
-
179
- <td rowspan="1" colSpan="1" >ContactGroupItem \| undefined</td>
180
-
181
- <td rowspan="1" colSpan="1" >`undefined`</td>
182
-
183
- <td rowspan="1" colSpan="1" >当前显示的联系人项</td>
184
- </tr>
185
-
186
- <tr>
187
- <td rowspan="1" colSpan="1" >showActions</td>
188
-
189
- <td rowspan="1" colSpan="1" >boolean</td>
190
-
191
- <td rowspan="1" colSpan="1" >`true`</td>
192
-
193
- <td rowspan="1" colSpan="1" >是否显示操作按钮</td>
194
- </tr>
195
-
196
- <tr>
197
- <td rowspan="1" colSpan="1" >PlaceholderEmpty</td>
198
-
199
- <td rowspan="1" colSpan="1" >React.ReactNode \| undefined</td>
200
-
201
- <td rowspan="1" colSpan="1" >`undefined`</td>
202
-
203
- <td rowspan="1" colSpan="1" >空状态占位组件</td>
204
- </tr>
205
-
206
- <tr>
207
- <td rowspan="1" colSpan="1" >FriendInfoComponent</td>
208
-
209
- <td rowspan="1" colSpan="1" >React.ComponentType<FriendInfoProps></td>
210
-
211
- <td rowspan="1" colSpan="1" >`FriendInfo`</td>
212
-
213
- <td rowspan="1" colSpan="1" >好友信息组件</td>
214
- </tr>
215
-
216
- <tr>
217
- <td rowspan="1" colSpan="1" >GroupInfoComponent</td>
218
-
219
- <td rowspan="1" colSpan="1" >React.ComponentType<GroupInfoProps></td>
220
-
221
- <td rowspan="1" colSpan="1" >`GroupInfo`</td>
222
-
223
- <td rowspan="1" colSpan="1" >群组信息组件</td>
224
- </tr>
225
-
226
- <tr>
227
- <td rowspan="1" colSpan="1" >BlacklistInfoComponent</td>
228
-
229
- <td rowspan="1" colSpan="1" >React.ComponentType<BlacklistInfoProps></td>
230
-
231
- <td rowspan="1" colSpan="1" >`BlacklistInfo`</td>
232
-
233
- <td rowspan="1" colSpan="1" >黑名单信息组件</td>
234
- </tr>
235
-
236
- <tr>
237
- <td rowspan="1" colSpan="1" >FriendApplicationInfoComponent</td>
238
-
239
- <td rowspan="1" colSpan="1" >React.ComponentType<FriendApplicationInfoProps></td>
240
-
241
- <td rowspan="1" colSpan="1" >`FriendApplicationInfo`</td>
242
-
243
- <td rowspan="1" colSpan="1" >好友申请信息组件</td>
244
- </tr>
245
-
246
- <tr>
247
- <td rowspan="1" colSpan="1" >GroupApplicationInfoComponent</td>
248
-
249
- <td rowspan="1" colSpan="1" >React.ComponentType<GroupApplicationInfoProps></td>
250
-
251
- <td rowspan="1" colSpan="1" >`GroupApplicationInfo`</td>
252
-
253
- <td rowspan="1" colSpan="1" >群组申请信息组件</td>
254
- </tr>
255
-
256
- <tr>
257
- <td rowspan="1" colSpan="1" >SearchGroupInfoComponent</td>
258
-
259
- <td rowspan="1" colSpan="1" >React.ComponentType<SearchGroupInfoProps></td>
260
-
261
- <td rowspan="1" colSpan="1" >`SearchGroupInfo`</td>
262
-
263
- <td rowspan="1" colSpan="1" >搜索群组信息组件</td>
264
- </tr>
265
-
266
- <tr>
267
- <td rowspan="1" colSpan="1" >SearchUserInfoComponent</td>
268
-
269
- <td rowspan="1" colSpan="1" >React.ComponentType<SearchUserInfoProps></td>
270
-
271
- <td rowspan="1" colSpan="1" >`SearchUserInfo`</td>
272
-
273
- <td rowspan="1" colSpan="1" >搜索用户信息组件</td>
274
- </tr>
275
-
276
- <tr>
277
- <td rowspan="1" colSpan="1" >onClose</td>
278
-
279
- <td rowspan="1" colSpan="1" >() => void</td>
280
-
281
- <td rowspan="1" colSpan="1" >`undefined`</td>
282
-
283
- <td rowspan="1" colSpan="1" >关闭信息面板回调</td>
284
- </tr>
285
-
286
- <tr>
287
- <td rowspan="1" colSpan="1" >onSendMessage</td>
288
-
289
- <td rowspan="1" colSpan="1" >(friend: Friend) => void</td>
290
-
291
- <td rowspan="1" colSpan="1" >`undefined`</td>
292
-
293
- <td rowspan="1" colSpan="1" >发送消息回调</td>
294
- </tr>
295
-
296
- <tr>
297
- <td rowspan="1" colSpan="1" >onDeleteFriend</td>
298
-
299
- <td rowspan="1" colSpan="1" >(friend: Friend) => void</td>
300
-
301
- <td rowspan="1" colSpan="1" >`undefined`</td>
302
-
303
- <td rowspan="1" colSpan="1" >删除好友回调</td>
304
- </tr>
305
-
306
- <tr>
307
- <td rowspan="1" colSpan="1" >onUpdateFriendRemark</td>
308
-
309
- <td rowspan="1" colSpan="1" >(friend: Friend, remark: string) => void</td>
310
-
311
- <td rowspan="1" colSpan="1" >`undefined`</td>
312
-
313
- <td rowspan="1" colSpan="1" >更新好友备注回调</td>
314
- </tr>
315
-
316
- <tr>
317
- <td rowspan="1" colSpan="1" >onAddToBlacklist</td>
318
-
319
- <td rowspan="1" colSpan="1" >(friend: Friend) => void</td>
320
-
321
- <td rowspan="1" colSpan="1" >`undefined`</td>
322
-
323
- <td rowspan="1" colSpan="1" >添加到黑名单回调</td>
324
- </tr>
325
-
326
- <tr>
327
- <td rowspan="1" colSpan="1" >onRemoveFromBlacklist</td>
328
-
329
- <td rowspan="1" colSpan="1" >(profile: UserProfile) => void</td>
330
-
331
- <td rowspan="1" colSpan="1" >`undefined`</td>
332
-
333
- <td rowspan="1" colSpan="1" >从黑名单移除回调</td>
334
- </tr>
335
-
336
- <tr>
337
- <td rowspan="1" colSpan="1" >onEnterGroup</td>
338
-
339
- <td rowspan="1" colSpan="1" >(group: GroupModel) => void</td>
340
-
341
- <td rowspan="1" colSpan="1" >`undefined`</td>
342
-
343
- <td rowspan="1" colSpan="1" >进入群组回调</td>
344
- </tr>
345
-
346
- <tr>
347
- <td rowspan="1" colSpan="1" >onLeaveGroup</td>
348
-
349
- <td rowspan="1" colSpan="1" >(group: GroupModel) => void</td>
350
-
351
- <td rowspan="1" colSpan="1" >`undefined`</td>
352
-
353
- <td rowspan="1" colSpan="1" >退出群组回调</td>
354
- </tr>
355
-
356
- <tr>
357
- <td rowspan="1" colSpan="1" >onDismissGroup</td>
358
-
359
- <td rowspan="1" colSpan="1" >(group: GroupModel) => void</td>
360
-
361
- <td rowspan="1" colSpan="1" >`undefined`</td>
362
-
363
- <td rowspan="1" colSpan="1" >解散群组回调</td>
364
- </tr>
365
-
366
- <tr>
367
- <td rowspan="1" colSpan="1" >onFriendApplicationAction</td>
368
-
369
- <td rowspan="1" colSpan="1" >(action: 'accept' \| 'refuse', application: FriendApplication) => void</td>
370
-
371
- <td rowspan="1" colSpan="1" >`undefined`</td>
372
-
373
- <td rowspan="1" colSpan="1" >好友申请操作回调</td>
374
- </tr>
375
-
376
- <tr>
377
- <td rowspan="1" colSpan="1" >onGroupApplicationAction</td>
378
-
379
- <td rowspan="1" colSpan="1" >(action: 'accept' \| 'refuse', application: GroupApplication) => void</td>
380
-
381
- <td rowspan="1" colSpan="1" >`undefined`</td>
382
-
383
- <td rowspan="1" colSpan="1" >群组申请操作回调</td>
384
- </tr>
385
-
386
- <tr>
387
- <td rowspan="1" colSpan="1" >onAddFriend</td>
388
-
389
- <td rowspan="1" colSpan="1" >(user: UserProfile, wording: string) => void</td>
390
-
391
- <td rowspan="1" colSpan="1" >`undefined`</td>
392
-
393
- <td rowspan="1" colSpan="1" >添加好友回调</td>
394
- </tr>
395
-
396
- <tr>
397
- <td rowspan="1" colSpan="1" >onJoinGroup</td>
398
-
399
- <td rowspan="1" colSpan="1" >(group: GroupModel, note: string) => void</td>
400
-
401
- <td rowspan="1" colSpan="1" >`undefined`</td>
402
-
403
- <td rowspan="1" colSpan="1" >加入群组回调</td>
404
- </tr>
405
- </table>
406
-
24
+ | 字段 | 类型 | 默认值 | 描述 |
25
+ | --- | --- | --- | --- |
26
+ | contactItem | ContactGroupItem \\| undefined | `undefined` | 当前显示的联系人项 |
27
+ | showActions | boolean | `true` | 是否显示操作按钮 |
28
+ | PlaceholderEmpty | React.ReactNode \\| undefined | `undefined` | 空状态占位组件 |
29
+ | FriendInfoComponent | React.ComponentType<FriendInfoProps> | `FriendInfo` | 好友信息组件 |
30
+ | GroupInfoComponent | React.ComponentType<GroupInfoProps> | `GroupInfo` | 群组信息组件 |
31
+ | BlacklistInfoComponent | React.ComponentType<BlacklistInfoProps> | `BlacklistInfo` | 黑名单信息组件 |
32
+ | FriendApplicationInfoComponent | React.ComponentType<FriendApplicationInfoProps> | `FriendApplicationInfo` | 好友申请信息组件 |
33
+ | GroupApplicationInfoComponent | React.ComponentType<GroupApplicationInfoProps> | `GroupApplicationInfo` | 群组申请信息组件 |
34
+ | SearchGroupInfoComponent | React.ComponentType<SearchGroupInfoProps> | `SearchGroupInfo` | 搜索群组信息组件 |
35
+ | SearchUserInfoComponent | React.ComponentType<SearchUserInfoProps> | `SearchUserInfo` | 搜索用户信息组件 |
36
+ | onClose | () => void | `undefined` | 关闭信息面板回调 |
37
+ | onSendMessage | (friend: Friend) => void | `undefined` | 发送消息回调 |
38
+ | onDeleteFriend | (friend: Friend) => void | `undefined` | 删除好友回调 |
39
+ | onUpdateFriendRemark | (friend: Friend, remark: string) => void | `undefined` | 更新好友备注回调 |
40
+ | onAddToBlacklist | (friend: Friend) => void | `undefined` | 添加到黑名单回调 |
41
+ | onRemoveFromBlacklist | (profile: UserProfile) => void | `undefined` | 从黑名单移除回调 |
42
+ | onEnterGroup | (group: GroupModel) => void | `undefined` | 进入群组回调 |
43
+ | onLeaveGroup | (group: GroupModel) => void | `undefined` | 退出群组回调 |
44
+ | onDismissGroup | (group: GroupModel) => void | `undefined` | 解散群组回调 |
45
+ | onFriendApplicationAction | (action: 'accept' \\| 'refuse', application: FriendApplication) => void | `undefined` | 好友申请操作回调 |
46
+ | onGroupApplicationAction | (action: 'accept' \\| 'refuse', application: GroupApplication) => void | `undefined` | 群组申请操作回调 |
47
+ | onAddFriend | (user: UserProfile, wording: string) => void | `undefined` | 添加好友回调 |
48
+ | onJoinGroup | (group: GroupModel, note: string) => void | `undefined` | 加入群组回调 |
407
49
 
408
50
  ## 基础使用
409
51
  ``` tsx
@@ -430,14 +72,10 @@ function App() {
430
72
 
431
73
  效果如下图所示:
432
74
 
433
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/2147e4f366de11f09b85525400bf7822.png)
434
-
435
75
  ### 自定义联系列表联系人分组配置
436
76
 
437
77
  `groupConfig` 用于自定义分组配置,包括标题、显示顺序、隐藏状态等,默认值为 `{}`。
438
78
 
439
-
440
-
441
79
  【自定义分组标题】
442
80
  ``` typescript
443
81
  import React from 'react';
@@ -473,8 +111,6 @@ function CustomGroupTitlesContactList() {
473
111
 
474
112
  效果如下图所示:
475
113
 
476
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/1c780045676711f09b85525400bf7822.png)
477
-
478
114
  【隐藏特定分组】
479
115
  ``` tsx
480
116
  import React from 'react';
@@ -506,8 +142,6 @@ function HiddenGroupsContactList() {
506
142
 
507
143
  效果如下图所示:
508
144
 
509
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/0b5061fa676711f0bd33525400e889b2.png)
510
-
511
145
  ### 自定义联系列表子项
512
146
 
513
147
  ContactItem 用于自定义联系人项的渲染组件,默认值为内置的 `ContactListItem` 组件。
@@ -516,10 +150,10 @@ import React from 'react';
516
150
  import { ContactList, Avatar } from '@tencentcloud/chat-uikit-react';
517
151
  import type { ContactListItemProps } from '@tencentcloud/chat-uikit-react';
518
152
 
519
- const SimpleContactItem: React.FC<ContactListItemProps> = ({
520
- contactItem,
521
- onClick,
522
- activeContactItem
153
+ const SimpleContactItem: React.FC<ContactListItemProps> = ({
154
+ contactItem,
155
+ onClick,
156
+ activeContactItem
523
157
  }) => {
524
158
  const isActive = activeContactItem?.data.userID === contactItem.data.userID;
525
159
 
@@ -556,8 +190,6 @@ function ContactListWithSimpleItems() {
556
190
 
557
191
  效果如下图所示:
558
192
 
559
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/849d4e5e66e111f0bd33525400e889b2.png)
560
-
561
193
  ### 自定义联系人详情操作按钮开关
562
194
 
563
195
  `showActions` 用于控制是否显示操作按钮,默认值为 `true`。
@@ -578,7 +210,7 @@ function ReadOnlyContactInfo() {
578
210
  };
579
211
 
580
212
  return (
581
- <ContactInfo
213
+ <ContactInfo
582
214
  contactItem={friendData}
583
215
  showActions={false} // 隐藏所有操作按钮,只显示信息
584
216
  />
@@ -588,9 +220,6 @@ function ReadOnlyContactInfo() {
588
220
 
589
221
  效果如下图所示:
590
222
 
591
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/0a5c7141676911f0b5365254001c06ec.png)
592
-
593
-
594
223
  ### 自定义联系人详情空状态
595
224
 
596
225
  `PlaceholderEmpty` 用于自定义空状态显示内容,默认值为 `undefined`。
@@ -600,9 +229,9 @@ import { ContactInfo } from '@tencentcloud/chat-uikit-react';
600
229
 
601
230
  function CustomEmptyState() {
602
231
  const EmptyPlaceholder = () => (
603
- <div style={{
232
+ <div style={{
604
233
  width: '100%',
605
- textAlign: 'center',
234
+ textAlign: 'center',
606
235
  padding: '40px 20px',
607
236
  color: '#999',
608
237
  fontSize: '14px',
@@ -617,7 +246,7 @@ function CustomEmptyState() {
617
246
  );
618
247
 
619
248
  return (
620
- <ContactInfo
249
+ <ContactInfo
621
250
  contactItem={undefined}
622
251
  PlaceholderEmpty={<EmptyPlaceholder />}
623
252
  />
@@ -627,22 +256,16 @@ function CustomEmptyState() {
627
256
 
628
257
  效果如下图所示:
629
258
 
630
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/4a270500676911f0924f5254005ef0f7.png)
631
-
632
-
633
259
  ### 自定义联系人详情组件
634
260
 
635
261
  > **说明:**
636
- >
262
+ >
637
263
  > - `FriendInfoComponent` 用于自定义好友信息组件,默认值为内置的 `FriendInfo` 组件。
638
264
  > - `GroupInfoComponent` 用于自定义群组信息组件,默认值为内置的 `GroupInfo` 组件。
639
265
  > - `BlacklistInfoComponent` 用于自定义黑名单信息组件,默认值为内置的 `BlacklistInfo` 组件。
640
266
  > - `FriendApplicationInfoComponent` 用于自定义好友申请信息组件,默认值为内置的 `FriendApplicationInfo` 组件。
641
267
  > - `GroupApplicationInfoComponent` 用于自定义群组申请信息组件,默认值为内置的 `GroupApplicationInfo` 组件。
642
268
 
643
-
644
-
645
-
646
269
  【自定义好友信息组件】
647
270
  ``` typescript
648
271
  import React from 'react';
@@ -651,34 +274,29 @@ import type { FriendInfoProps, Friend } from '@tencentcloud/chat-uikit-react';
651
274
  import { Button } from '@tencentcloud/uikit-base-component-react';
652
275
 
653
276
  // 自定义好友信息组件
654
- const CustomFriendInfo: React.FC<FriendInfoProps> = ({
655
- friend,
656
- showActions,
657
- onClose,
277
+ const CustomFriendInfo: React.FC<FriendInfoProps> = ({
278
+ friend,
279
+ showActions,
280
+ onClose,
658
281
  onSendMessage,
659
- onDeleteFriend
282
+ onDeleteFriend
660
283
  }) => {
661
284
  return (
662
285
  <div style={{ padding: '20px', border: '1px solid #e0e0e0', borderRadius: '8px' }}>
663
286
  <div style={{ display: 'flex', alignItems: 'center', marginBottom: '16px' }}>
664
- <img
665
- src={friend.avatar}
666
- alt="avatar"
667
- style={{ width: '60px', height: '60px', borderRadius: '50%', marginRight: '16px' }}
668
- />
287
+
669
288
  <div>
670
289
  <h3 style={{ margin: '0 0 4px 0' }}>{friend.nick}</h3>
671
290
  <p style={{ margin: '0', color: '#666' }}>备注: {friend.remark}</p>
672
291
  </div>
673
292
  </div>
674
-
293
+
675
294
  <div style={{ display: 'flex', flexDirection: 'column', gap: '10px', marginBottom: '16px' }}>
676
295
  <p><strong>用户ID:</strong> {friend.userID}</p>
677
296
  <p><strong>个性签名:</strong> {friend.selfSignature}</p>
678
297
  <p><strong>位置:</strong> {friend.location}</p>
679
298
  </div>
680
299
 
681
-
682
300
  {showActions && (
683
301
  <div style={{ display: 'flex', gap: '8px' }}>
684
302
  <Button onClick={() => onSendMessage?.(friend)}>发送消息</Button>
@@ -705,7 +323,7 @@ function CustomFriendInfoDemo() {
705
323
  };
706
324
 
707
325
  return (
708
- <ContactInfo
326
+ <ContactInfo
709
327
  contactItem={friendData}
710
328
  FriendInfoComponent={CustomFriendInfo}
711
329
  onSendMessage={(friend) => console.log('发送消息给:', friend.nick)}
@@ -717,8 +335,6 @@ function CustomFriendInfoDemo() {
717
335
 
718
336
  效果如下图所示:
719
337
 
720
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/56337044676a11f0b5365254001c06ec.png)
721
-
722
338
  【自定义群组信息组件】
723
339
  ``` typescript
724
340
  import React from 'react';
@@ -727,13 +343,13 @@ import type { GroupInfoProps, GroupModel } from '@tencentcloud/uikit-component-r
727
343
  import { Button } from '@tencentcloud/uikit-base-component-react';
728
344
 
729
345
  // 自定义群组信息组件
730
- const CustomGroupInfo: React.FC<GroupInfoProps> = ({
731
- group,
732
- showActions,
733
- onClose,
346
+ const CustomGroupInfo: React.FC<GroupInfoProps> = ({
347
+ group,
348
+ showActions,
349
+ onClose,
734
350
  onEnterGroup,
735
351
  onLeaveGroup,
736
- onDismissGroup
352
+ onDismissGroup
737
353
  }) => {
738
354
  const isOwner = group.selfInfo?.role === GroupMemberRole.OWNER; // 群主
739
355
  const isAdmin = group.selfInfo?.role === GroupMemberRole.ADMIN; // 管理员
@@ -741,11 +357,7 @@ const CustomGroupInfo: React.FC<GroupInfoProps> = ({
741
357
  return (
742
358
  <div style={{ padding: '20px', border: '1px solid #e0e0e0', borderRadius: '8px' }}>
743
359
  <div style={{ display: 'flex', alignItems: 'center', marginBottom: '16px' }}>
744
- <img
745
- src={group.avatar}
746
- alt="group avatar"
747
- style={{ width: '60px', height: '60px', borderRadius: '8px', marginRight: '16px' }}
748
- />
360
+
749
361
  <div>
750
362
  <h3 style={{ margin: '0 0 4px 0' }}>{group.name}</h3>
751
363
  <p style={{ margin: '0', color: '#666' }}>
@@ -753,7 +365,7 @@ const CustomGroupInfo: React.FC<GroupInfoProps> = ({
753
365
  </p>
754
366
  </div>
755
367
  </div>
756
-
368
+
757
369
  <div style={{ display: 'flex', flexDirection: 'column', gap: '10px', marginBottom: '16px' }}>
758
370
  <p><strong>群组介绍:</strong> {group.introduction}</p>
759
371
  <p><strong>群组公告:</strong> {group.notification}</p>
@@ -800,7 +412,7 @@ function CustomGroupInfoDemo() {
800
412
  };
801
413
 
802
414
  return (
803
- <ContactInfo
415
+ <ContactInfo
804
416
  contactItem={groupData}
805
417
  GroupInfoComponent={CustomGroupInfo}
806
418
  onEnterGroup={(group) => console.log('进入群组:', group.name)}
@@ -813,8 +425,6 @@ function CustomGroupInfoDemo() {
813
425
 
814
426
  效果如下图所示:
815
427
 
816
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/c93c8710676b11f0bd33525400e889b2.png)
817
-
818
428
  【自定义黑名单信息组件】
819
429
  ``` typescript
820
430
  import React from 'react';
@@ -823,26 +433,22 @@ import type { BlacklistInfoProps, UserProfile } from '@tencentcloud/uikit-compon
823
433
  import { Button } from '@tencentcloud/uikit-base-component-react';
824
434
 
825
435
  // 自定义黑名单信息组件
826
- const CustomBlacklistInfo: React.FC<BlacklistInfoProps> = ({
827
- profile,
828
- showActions,
829
- onClose,
830
- onRemoveFromBlacklist
436
+ const CustomBlacklistInfo: React.FC<BlacklistInfoProps> = ({
437
+ profile,
438
+ showActions,
439
+ onClose,
440
+ onRemoveFromBlacklist
831
441
  }) => {
832
442
  return (
833
443
  <div style={{ padding: '20px', border: '1px solid #e0e0e0', borderRadius: '8px' }}>
834
444
  <div style={{ display: 'flex', alignItems: 'center', marginBottom: '16px' }}>
835
- <img
836
- src={profile.src}
837
- alt="avatar"
838
- style={{ width: '60px', height: '60px', borderRadius: '50%', marginRight: '16px' }}
839
- />
445
+
840
446
  <div>
841
447
  <h3 style={{ margin: '0 0 4px 0', color: '#ff4d4f' }}>{profile.nick}</h3>
842
448
  <p style={{ margin: '0', color: '#666' }}>用户ID: {profile.userID}</p>
843
449
  </div>
844
450
  </div>
845
-
451
+
846
452
  <div style={{ display: 'flex', flexDirection: 'column', gap: '10px', marginBottom: '16px' }}>
847
453
  <p><strong>个性签名:</strong> {profile.selfSignature}</p>
848
454
  <p><strong>位置:</strong> {profile.location}</p>
@@ -853,7 +459,7 @@ const CustomBlacklistInfo: React.FC<BlacklistInfoProps> = ({
853
459
 
854
460
  {showActions && (
855
461
  <div style={{ display: 'flex', gap: '8px' }}>
856
- <Button
462
+ <Button
857
463
  onClick={() => onRemoveFromBlacklist?.(profile)}
858
464
  style={{ backgroundColor: '#52c41a', color: 'white', border: 'none' }}
859
465
  >
@@ -883,7 +489,7 @@ function CustomBlacklistInfoDemo() {
883
489
  };
884
490
 
885
491
  return (
886
- <ContactInfo
492
+ <ContactInfo
887
493
  contactItem={blacklistData}
888
494
  BlacklistInfoComponent={CustomBlacklistInfo}
889
495
  onRemoveFromBlacklist={(profile) => console.log('移出黑名单:', profile.nick)}
@@ -894,8 +500,6 @@ function CustomBlacklistInfoDemo() {
894
500
 
895
501
  效果如下图所示:
896
502
 
897
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/e8aea7e0676c11f09b85525400bf7822.png)
898
-
899
503
  【自定义好友申请信息组件】
900
504
  ``` typescript
901
505
  import React from 'react';
@@ -904,12 +508,12 @@ import type { FriendApplicationInfoProps, FriendApplication } from '@tencentclou
904
508
  import { Button } from '@tencentcloud/uikit-base-component-react';
905
509
 
906
510
  // 自定义好友申请信息组件
907
- const CustomFriendApplicationInfo: React.FC<FriendApplicationInfoProps> = ({
908
- application,
909
- showActions,
910
- onClose,
511
+ const CustomFriendApplicationInfo: React.FC<FriendApplicationInfoProps> = ({
512
+ application,
513
+ showActions,
514
+ onClose,
911
515
  onAccept,
912
- onRefuse
516
+ onRefuse
913
517
  }) => {
914
518
  const formatTime = (timestamp: number) => {
915
519
  return new Date(timestamp).toLocaleString();
@@ -918,17 +522,13 @@ const CustomFriendApplicationInfo: React.FC<FriendApplicationInfoProps> = ({
918
522
  return (
919
523
  <div style={{ padding: '20px', border: '1px solid #e0e0e0', borderRadius: '8px' }}>
920
524
  <div style={{ display: 'flex', alignItems: 'center', marginBottom: '16px' }}>
921
- <img
922
- src={application.src}
923
- alt="avatar"
924
- style={{ width: '60px', height: '60px', borderRadius: '50%', marginRight: '16px' }}
925
- />
525
+
926
526
  <div>
927
527
  <h3 style={{ margin: '0 0 4px 0' }}>{application.nick}</h3>
928
528
  <p style={{ margin: '0', color: '#666' }}>申请时间: {formatTime(application.time)}</p>
929
529
  </div>
930
530
  </div>
931
-
531
+
932
532
  <div style={{ display: 'flex', flexDirection: 'column', gap: '10px', marginBottom: '16px' }}>
933
533
  <p><strong>申请来源:</strong> {application.source}</p>
934
534
  <p><strong>申请附言:</strong> {application.wording}</p>
@@ -939,13 +539,13 @@ const CustomFriendApplicationInfo: React.FC<FriendApplicationInfoProps> = ({
939
539
 
940
540
  {showActions && (
941
541
  <div style={{ display: 'flex', gap: '8px' }}>
942
- <Button
542
+ <Button
943
543
  onClick={() => onAccept?.(application)}
944
544
  style={{ backgroundColor: '#52c41a', color: 'white', border: 'none' }}
945
545
  >
946
546
  接受申请
947
547
  </Button>
948
- <Button
548
+ <Button
949
549
  onClick={() => onRefuse?.(application)}
950
550
  style={{ backgroundColor: '#ff4d4f', color: 'white', border: 'none' }}
951
551
  >
@@ -973,7 +573,7 @@ function CustomFriendApplicationInfoDemo() {
973
573
  };
974
574
 
975
575
  return (
976
- <ContactInfo
576
+ <ContactInfo
977
577
  contactItem={applicationData}
978
578
  FriendApplicationInfoComponent={CustomFriendApplicationInfo}
979
579
  onFriendApplicationAction={(action, application) => {
@@ -990,8 +590,6 @@ function CustomFriendApplicationInfoDemo() {
990
590
 
991
591
  效果如下图所示:
992
592
 
993
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/42ea5e27676e11f0924f5254005ef0f7.png)
994
-
995
593
  【自定义群组申请信息组件】
996
594
  ``` typescript
997
595
  import React from 'react';
@@ -1000,12 +598,12 @@ import type { GroupApplicationInfoProps, GroupApplication } from '@tencentcloud/
1000
598
  import { Button } from '@tencentcloud/uikit-base-component-react';
1001
599
 
1002
600
  // 自定义群组申请信息组件
1003
- const CustomGroupApplicationInfo: React.FC<GroupApplicationInfoProps> = ({
1004
- application,
1005
- showActions,
1006
- onClose,
601
+ const CustomGroupApplicationInfo: React.FC<GroupApplicationInfoProps> = ({
602
+ application,
603
+ showActions,
604
+ onClose,
1007
605
  onAccept,
1008
- onRefuse
606
+ onRefuse
1009
607
  }) => {
1010
608
  const getApplicationTypeText = (type: number) => {
1011
609
  return type === 0 ? '用户申请加入' : '邀请用户加入';
@@ -1024,7 +622,7 @@ const CustomGroupApplicationInfo: React.FC<GroupApplicationInfoProps> = ({
1024
622
  </p>
1025
623
  </div>
1026
624
  </div>
1027
-
625
+
1028
626
  <div style={{ display: 'flex', flexDirection: 'column', gap: '10px', marginBottom: '16px' }}>
1029
627
  <p><strong>申请人:</strong> {application.applicantNick}</p>
1030
628
  <p><strong>群组ID:</strong> {application.groupID}</p>
@@ -1036,13 +634,13 @@ const CustomGroupApplicationInfo: React.FC<GroupApplicationInfoProps> = ({
1036
634
 
1037
635
  {showActions && (
1038
636
  <div style={{ display: 'flex', gap: '8px' }}>
1039
- <Button
637
+ <Button
1040
638
  onClick={() => onAccept?.(application)}
1041
639
  style={{ backgroundColor: '#52c41a', color: 'white', border: 'none' }}
1042
640
  >
1043
641
  同意申请
1044
642
  </Button>
1045
- <Button
643
+ <Button
1046
644
  onClick={() => onRefuse?.(application)}
1047
645
  style={{ backgroundColor: '#ff4d4f', color: 'white', border: 'none' }}
1048
646
  >
@@ -1070,7 +668,7 @@ function CustomGroupApplicationInfoDemo() {
1070
668
  };
1071
669
 
1072
670
  return (
1073
- <ContactInfo
671
+ <ContactInfo
1074
672
  contactItem={applicationData}
1075
673
  GroupApplicationInfoComponent={CustomGroupApplicationInfo}
1076
674
  onGroupApplicationAction={(action, application) => {
@@ -1087,219 +685,40 @@ function CustomGroupApplicationInfoDemo() {
1087
685
 
1088
686
  效果如下图所示:
1089
687
 
1090
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/44424b79676f11f09a9d52540044a08e.png)
1091
-
1092
688
  ## useContactListState
1093
689
 
1094
690
  ContactListState 是基于 Zustand 的关系链管理钩子,为 ContactLis 组件提供完整的数据管理能力。它支持好友列表、群组列表、黑名单和申请管理等功能关了。如果自定义组件能力不能支持您的业务,可以使用 ContactListState 实现您的需求。
1095
691
 
1096
692
  ### 数据
1097
- <table>
1098
- <tr>
1099
- <td rowspan="1" colSpan="1" >属性名</td>
1100
-
1101
- <td rowspan="1" colSpan="1" >类型</td>
1102
-
1103
- <td rowspan="1" colSpan="1" >说明</td>
1104
- </tr>
1105
-
1106
- <tr>
1107
- <td rowspan="1" colSpan="1" >friendList</td>
1108
-
1109
- <td rowspan="1" colSpan="1" >Friend[]</td>
1110
-
1111
- <td rowspan="1" colSpan="1" >好友列表</td>
1112
- </tr>
1113
-
1114
- <tr>
1115
- <td rowspan="1" colSpan="1" >groupList</td>
1116
-
1117
- <td rowspan="1" colSpan="1" >Group[]</td>
1118
-
1119
- <td rowspan="1" colSpan="1" >群组列表</td>
1120
- </tr>
1121
-
1122
- <tr>
1123
- <td rowspan="1" colSpan="1" >blackList</td>
1124
-
1125
- <td rowspan="1" colSpan="1" >UserProfile[]</td>
1126
-
1127
- <td rowspan="1" colSpan="1" >黑名单列表</td>
1128
- </tr>
1129
-
1130
- <tr>
1131
- <td rowspan="1" colSpan="1" >friendApplicationUnreadCount</td>
1132
-
1133
- <td rowspan="1" colSpan="1" >number</td>
1134
-
1135
- <td rowspan="1" colSpan="1" >未读好友申请数量</td>
1136
- </tr>
1137
-
1138
- <tr>
1139
- <td rowspan="1" colSpan="1" >friendGroupList</td>
1140
-
1141
- <td rowspan="1" colSpan="1" >FriendGroup[]</td>
1142
-
1143
- <td rowspan="1" colSpan="1" >好友分组列表</td>
1144
- </tr>
1145
-
1146
- <tr>
1147
- <td rowspan="1" colSpan="1" >friendApplicationList</td>
1148
-
1149
- <td rowspan="1" colSpan="1" >FriendApplication[]</td>
1150
-
1151
- <td rowspan="1" colSpan="1" >好友申请列表</td>
1152
- </tr>
1153
-
1154
- <tr>
1155
- <td rowspan="1" colSpan="1" >groupApplicationList</td>
1156
-
1157
- <td rowspan="1" colSpan="1" >GroupApplication[]</td>
1158
-
1159
- <td rowspan="1" colSpan="1" >群组申请列表</td>
1160
- </tr>
1161
- </table>
1162
-
693
+ | 属性名 | 类型 | 说明 |
694
+ | --- | --- | --- |
695
+ | friendList | Friend[] | 好友列表 |
696
+ | groupList | Group[] | 群组列表 |
697
+ | blackList | UserProfile[] | 黑名单列表 |
698
+ | friendApplicationUnreadCount | number | 未读好友申请数量 |
699
+ | friendGroupList | FriendGroup[] | 好友分组列表 |
700
+ | friendApplicationList | FriendApplication[] | 好友申请列表 |
701
+ | groupApplicationList | GroupApplication[] | 群组申请列表 |
1163
702
 
1164
703
  ### 操作方法
1165
- <table>
1166
- <tr>
1167
- <td rowspan="1" colSpan="1" >属性名</td>
1168
-
1169
- <td rowspan="1" colSpan="1" >类型</td>
1170
-
1171
- <td rowspan="1" colSpan="1" >说明</td>
1172
- </tr>
1173
-
1174
- <tr>
1175
- <td rowspan="1" colSpan="1" >addFriend</td>
1176
-
1177
- <td rowspan="1" colSpan="1" >(options: AddFriendParams) => Promise</td>
1178
-
1179
- <td rowspan="1" colSpan="1" >添加好友</td>
1180
- </tr>
1181
-
1182
- <tr>
1183
- <td rowspan="1" colSpan="1" >deleteFriend</td>
1184
-
1185
- <td rowspan="1" colSpan="1" >(options: DeleteFriendParams) => Promise</td>
1186
-
1187
- <td rowspan="1" colSpan="1" >删除好友</td>
1188
- </tr>
1189
-
1190
- <tr>
1191
- <td rowspan="1" colSpan="1" >setFriendRemark</td>
1192
-
1193
- <td rowspan="1" colSpan="1" >(options: FriendRemarkParams) => Promise</td>
1194
-
1195
- <td rowspan="1" colSpan="1" >设置好友备注</td>
1196
- </tr>
1197
-
1198
- <tr>
1199
- <td rowspan="1" colSpan="1" >markFriendApplicationAsRead</td>
1200
-
1201
- <td rowspan="1" colSpan="1" >() => Promise</td>
1202
-
1203
- <td rowspan="1" colSpan="1" >标记好友申请为已读</td>
1204
- </tr>
1205
-
1206
- <tr>
1207
- <td rowspan="1" colSpan="1" >acceptFriendApplication</td>
1208
-
1209
- <td rowspan="1" colSpan="1" >(options: FriendApplicationParams) => Promise</td>
1210
-
1211
- <td rowspan="1" colSpan="1" >接受好友申请</td>
1212
- </tr>
1213
-
1214
- <tr>
1215
- <td rowspan="1" colSpan="1" >refuseFriendApplication</td>
1216
-
1217
- <td rowspan="1" colSpan="1" >(userID: string) => Promise</td>
1218
-
1219
- <td rowspan="1" colSpan="1" >拒绝好友申请</td>
1220
- </tr>
1221
-
1222
- <tr>
1223
- <td rowspan="1" colSpan="1" >addToBlacklist</td>
1224
-
1225
- <td rowspan="1" colSpan="1" >(userIDList: string[]) => Promise</td>
1226
-
1227
- <td rowspan="1" colSpan="1" >添加到黑名单</td>
1228
- </tr>
1229
-
1230
- <tr>
1231
- <td rowspan="1" colSpan="1" >removeFromBlacklist</td>
1232
-
1233
- <td rowspan="1" colSpan="1" >(userIDList: string[]) => Promise</td>
1234
-
1235
- <td rowspan="1" colSpan="1" >从黑名单移除</td>
1236
- </tr>
1237
-
1238
- <tr>
1239
- <td rowspan="1" colSpan="1" >createFriendGroup</td>
1240
-
1241
- <td rowspan="1" colSpan="1" >(options: FriendGroupParams) => Promise</td>
1242
-
1243
- <td rowspan="1" colSpan="1" >创建好友分组</td>
1244
- </tr>
1245
-
1246
- <tr>
1247
- <td rowspan="1" colSpan="1" >deleteFriendGroup</td>
1248
-
1249
- <td rowspan="1" colSpan="1" >(name: string) => Promise</td>
1250
-
1251
- <td rowspan="1" colSpan="1" >删除好友分组</td>
1252
- </tr>
1253
-
1254
- <tr>
1255
- <td rowspan="1" colSpan="1" >addToFriendGroup</td>
1256
-
1257
- <td rowspan="1" colSpan="1" >(options: FriendGroupParams) => Promise</td>
1258
-
1259
- <td rowspan="1" colSpan="1" >添加好友到分组</td>
1260
- </tr>
1261
-
1262
- <tr>
1263
- <td rowspan="1" colSpan="1" >removeFromFriendGroup</td>
1264
-
1265
- <td rowspan="1" colSpan="1" >(options: FriendGroupParams) => Promise</td>
1266
-
1267
- <td rowspan="1" colSpan="1" >从分组移除好友</td>
1268
- </tr>
1269
-
1270
- <tr>
1271
- <td rowspan="1" colSpan="1" >renameFriendGroup</td>
1272
-
1273
- <td rowspan="1" colSpan="1" >(options: RenameFriendGroupParams) => Promise</td>
1274
-
1275
- <td rowspan="1" colSpan="1" >重命名好友分组</td>
1276
- </tr>
1277
-
1278
- <tr>
1279
- <td rowspan="1" colSpan="1" >joinGroup</td>
1280
-
1281
- <td rowspan="1" colSpan="1" >(options: JoinGroupParams) => Promise</td>
1282
-
1283
- <td rowspan="1" colSpan="1" >申请加入群组</td>
1284
- </tr>
1285
-
1286
- <tr>
1287
- <td rowspan="1" colSpan="1" >acceptGroupApplication</td>
1288
-
1289
- <td rowspan="1" colSpan="1" >(options: GroupApplicationParams) => Promise</td>
1290
-
1291
- <td rowspan="1" colSpan="1" >接受群组申请</td>
1292
- </tr>
1293
-
1294
- <tr>
1295
- <td rowspan="1" colSpan="1" >refuseGroupApplication</td>
1296
-
1297
- <td rowspan="1" colSpan="1" >(options: GroupApplicationParams) => Promise</td>
1298
-
1299
- <td rowspan="1" colSpan="1" >拒绝群组申请</td>
1300
- </tr>
1301
- </table>
1302
-
704
+ | 属性名 | 类型 | 说明 |
705
+ | --- | --- | --- |
706
+ | addFriend | (options: AddFriendParams) => Promise | 添加好友 |
707
+ | deleteFriend | (options: DeleteFriendParams) => Promise | 删除好友 |
708
+ | setFriendRemark | (options: FriendRemarkParams) => Promise | 设置好友备注 |
709
+ | markFriendApplicationAsRead | () => Promise | 标记好友申请为已读 |
710
+ | acceptFriendApplication | (options: FriendApplicationParams) => Promise | 接受好友申请 |
711
+ | refuseFriendApplication | (userID: string) => Promise | 拒绝好友申请 |
712
+ | addToBlacklist | (userIDList: string[]) => Promise | 添加到黑名单 |
713
+ | removeFromBlacklist | (userIDList: string[]) => Promise | 从黑名单移除 |
714
+ | createFriendGroup | (options: FriendGroupParams) => Promise | 创建好友分组 |
715
+ | deleteFriendGroup | (name: string) => Promise | 删除好友分组 |
716
+ | addToFriendGroup | (options: FriendGroupParams) => Promise | 添加好友到分组 |
717
+ | removeFromFriendGroup | (options: FriendGroupParams) => Promise | 从分组移除好友 |
718
+ | renameFriendGroup | (options: RenameFriendGroupParams) => Promise | 重命名好友分组 |
719
+ | joinGroup | (options: JoinGroupParams) => Promise | 申请加入群组 |
720
+ | acceptGroupApplication | (options: GroupApplicationParams) => Promise | 接受群组申请 |
721
+ | refuseGroupApplication | (options: GroupApplicationParams) => Promise | 拒绝群组申请 |
1303
722
 
1304
723
  ## 使用示例
1305
724
  ``` typescript