@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1

package/resource/knowledge/chat/preset/ios/features/search.md

@@ -0,0 +1,94 @@
+## **组件概述**
+
+Search 是搜索组件，为用户提供搜索框、搜索结果展示、界面跳转等功能的完整组件集合。该组件支持用户搜索、群组搜索、消息搜索等功能，并提供了丰富的交互回调接口。
+
+> **说明：**
+>
+
+> 搜索为旗舰版或企业版功能，购买旗舰版或企业版套餐包后可使用，详情请参见 [价格说明](https://cloud.tencent.com/document/product/269/81908#FUNCDetail)。
+>
+
+| <strong>搜索入口</strong> | <strong>搜索结果</strong> |
+| --- | --- |
+|  |  |
+
+## 组件集成
+
+Search 组件属于 TUIKit SwiftUI 的一部分，集成 TUIKit SwiftUI 即可获取并使用 Search 组件。集成方法请参考文档 [TUIKit SwiftUI](https://cloud.tencent.com/document/product/269/124935) 里的集成步骤，完成登录操作。
+
+## 组件构成
+
+`SearchBar` 是搜索的入口组件，对外仅暴露了搜索组件的初始化方法，其他逻辑均封装在 `SearchBar` 中。
+
+|方法名|参数|描述|
+|---------|---------|---------|
+|`init`|`onTapItem: @escaping (Any) -> Void`|点击搜索到的结果回调，包括好友、群组、消息、会话等搜索结果条目。|
+
+## 基础用法
+
+`SearchBar` 的搜索结果路由跳转如下：
+- 自动路由：在搜索结果界面中，点击更多（More）按钮或聊天记录列表时，组件内部会通过 Navigator 自动完成页面跳转。
+
+- 自定义路由：当用户点击具体的联系人、群组、会话或消息时，组件会触发相应的回调 `onTapItem: @escaping (Any) -> Void`，需在回调中实现自定义跳转（例如跳转到您的自定义聊天界面）。
+
+   示例代码如下：
+
+   ``` java
+   // 初始化 SearchBar
+   SearchBar(onTapItem: { result in
+       handleSearchResult(result)
+   })
+
+   // 响应搜索结果的点击事件
+   // onConversationClick 是将事件抛给更上层，非必须。是否这样处理取决于开发者的项目层级。
+   private func handleSearchResult(_ result: Any) {
+           if let friendInfo = result as? FriendSearchInfo {
+               // 解析出联系人结果点击信息
+               let conversationID = ChatUtil.getC2CConversationID(friendInfo.userID)
+               var conversation = ConversationInfo(conversationID: conversationID)
+               conversation.type = .c2c
+               conversation.title = friendInfo.friendRemark ?? friendInfo.userInfo.nickname
+               conversation.avatarURL = friendInfo.userInfo.avatarURL
+               // 将事件抛到上层，由上层处理跳转单聊列表
+               onConversationClick?(NavigationInfo(conversation: conversation))
+           } else if let groupInfo = result as? GroupSearchInfo {
+               // 解析出群组结果点击信息
+               let conversationID = ChatUtil.getGroupConversationID(groupInfo.groupID)
+               var conversation = ConversationInfo(conversationID: conversationID)
+               conversation.type = .group
+               conversation.title = groupInfo.groupName
+               conversation.avatarURL = groupInfo.groupAvatarURL
+               // 将事件抛到上层，由上层处理跳转群聊列表
+               onConversationClick?(NavigationInfo(conversation: conversation))
+           } else if let messageDict = result as? [String: Any],
+                     let messageInfo = messageDict["message"] as? MessageInfo,
+                     let conversationID = messageDict["conversationID"] as? String
+           {
+               // 解析出消息结果点击信息
+               var conversation = ConversationInfo(conversationID: conversationID)
+               if conversationID.hasPrefix("c2c_") {
+                   conversation.type = .c2c
+               } else {
+                   conversation.type = .group
+               }
+               conversation.title = messageDict["conversationName"] as? String
+               conversation.avatarURL = messageDict["conversationAvatar"] as? String
+               // 将事件抛到上层，由上层处理跳转会话，且定位到指定消息
+               onConversationClick?(NavigationInfo(conversation: conversation, locateMessage: messageInfo))
+           } else if let conversationDict = result as? [String: Any],
+                     let conversationID = conversationDict["conversationID"] as? String
+           {
+               // 解析出会话结果点击信息
+               var conversation = ConversationInfo(conversationID: conversationID)
+               if conversationID.hasPrefix("c2c_") {
+                   conversation.type = .c2c
+               } else {
+                   conversation.type = .group
+               }
+               conversation.title = conversationDict["conversationName"] as? String
+               conversation.avatarURL = conversationDict["conversationAvatar"] as? String
+               // 将事件抛到上层，由上层处理跳转会话
+               onConversationClick?(NavigationInfo(conversation: conversation))
+           }
+       }
+   ```

package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md

@@ -1,7 +1,7 @@
 TUIKit SwiftUI 提供了强大的外观定制能力，支持自定义应用的主题模式（浅色/深色/跟随系统）和主题色。通过简单的配置，开发者可以轻松实现应用级别的主题切换和品牌色定制。
 
 以消息列表为例，自定义主题模式和主题色的效果如下图所示：
-| **浅色 + 默认颜色** | **浅色 + 橘黄色** | **深色 + 默认颜色** | **深色 + 绿色主题** |
+| <strong>浅色 + 默认颜色</strong> | <strong>浅色 + 橘黄色</strong> | <strong>深色 + 默认颜色</strong> | <strong>深色 + 绿色主题</strong> |
 | --- | --- | --- | --- |
 |  |  |  |  |
 
@@ -31,29 +31,31 @@ TUIKit SwiftUI 提供了强大的外观定制能力，支持自定义应用的
 ### 设置主题模式
 | 方法 | 参数 | 返回值 | 说明 |
 | --- | --- | --- | --- |
-| `setThemeMode(_:)` | `ThemeMode` | `Void` | 设置显示模式，自动保存并刷新。<br>• `.system`：跟随系统外观。<br>• `.light`：强制使用浅色模式。<br>• `.dark`：强制使用深色模式。 |
+| <code>setThemeMode(_:)</code> | <code>ThemeMode</code> | <code>Void</code> | 设置显示模式，自动保存并刷新。<br>- ThemeMode.system：跟随系统外观。<br>- ThemeMode.light：强制使用浅色模式。<br>- ThemeMode.dark：强制使用深色模式。 |
 
 ### 设置主题色
-| 方法 | 参数 | 返回值 | 说明 |
-| --- | --- | --- | --- |
-| `setPrimaryColor(_:)` | `String` | `Void` | 设置主题色，需要 Hex 格式（例如 "#1C66E5"）。 |
-| `clearPrimaryColor()` | 无 | `Void` | 清除自定义主题色，恢复默认蓝色。 |
+
+|方法|参数|返回值|说明|
+|---------|---------|---------|---------|
+|`setPrimaryColor(_:)`|`String`|`Void`|设置主题色，需要 Hex 格式（例如 "#1C66E5"）。|
+|`clearPrimaryColor()`|无|`Void`|清除自定义主题色，恢复默认蓝色。|
 
 > **说明：**
 >
 > 1. 调用 `setThemeMode` 或 `setPrimaryColor` 后，配置会自动保存到 `UserDefaults`，无需手动保存。下次启动应用时会自动加载。
 > 2. 修改主题配置时会自动清除缓存，确保色彩方案实时更新。开发者无需关心缓存管理。
-> 3. 使用设置 API 时需避免频繁切换主题（如在循环中调用）。
+> 3. 使用设置 API 时需避免频繁切换主题（例如在循环中调用）。
 
 ### 查询 ThemeState 信息
 
 通过以下只读属性可以查询当前的主题配置状态和信息：
-| 属性 | 类型 | 说明 |
-| --- | --- | --- |
-| `currentMode` | `ThemeMode` | 当前主题模式。 |
-| `currentPrimaryColor` | `String?` | 当前主题色（Hex 格式）。 |
-| `hasCustomPrimaryColor` | `Bool` | 是否设置了自定义主题色。 |
-| `isDarkMode` | `Bool` | 当前是否为深色模式。 |
+
+|属性|类型|说明|
+|---------|---------|---------|
+|`currentMode`|`ThemeMode`|当前主题模式。|
+|`currentPrimaryColor`|`String?`|当前主题色（Hex 格式）。|
+|`hasCustomPrimaryColor`|`Bool`|是否设置了自定义主题色。|
+|`isDarkMode`|`Bool`|当前是否为深色模式。|
 
 ## 使用方式
 
@@ -63,7 +65,7 @@ TUIKit SwiftUI 提供了强大的外观定制能力，支持自定义应用的
 
 AppBuilder是一个便捷式功能及 UI 自定义配置工具，通过 JSON 配置文件统一管理，适用于 Web + Native 双端应用需要保持统一外观的场景。
 
-您可以在 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail?scene=messenger) 体验 AppBuilder 功能，体验入口：
+您可以在 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail) 体验 AppBuilder 功能，体验入口：
 
 虽然 Chat Web 体验馆上暂时无法实时观看移动端的配置效果，但移动端已经预先支持了 AppBuilder 的配置能力。
 
@@ -76,7 +78,7 @@ AppBuilder是一个便捷式功能及 UI 自定义配置工具，通过 JSON 配
 
 #### 步骤1：下载配置文件
 
-访问 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail?scene=messenger)，下载配置文件 appConfig.json。下载路径为：
+访问 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail)，下载配置文件 appConfig.json。下载路径为：
 
 `appConfig.json`文件内容如下所示，与 AppBuilder 页面的配置项一一对应，与定义外观相关的配置是 `theme`及其子字段：
 ``` json
@@ -119,16 +121,17 @@ AppBuilder是一个便捷式功能及 UI 自定义配置工具，通过 JSON 配
 ```
 
 **配置选项说明**
-| 参数说明 | 类型 | 可选值 | 说明 |
-| --- | --- | --- | --- |
-| `mode` | String | `"system"`, `"light"`, `"dark"` | 主题模式。 |
-| `primaryColor` | String | Hex 颜色值，例如 `"#0ABF77"` | 主题色。 |
+
+|参数说明|类型|可选值|说明|
+|---------|---------|---------|---------|
+|`mode`|String|`"system"`, `"light"`, `"dark"`|主题模式。|
+|`primaryColor`|String|Hex 颜色值，例如 `"#0ABF77"`|主题色。|
 
 #### 步骤2：将配置文件拖入项目中
 
 将 appConfig.json 拖入您的项目中，确保选择了正确的 Target，以及正常勾选了 Copy Bundle Resources。
 
-以 Github 开源 Demo [TUIKit iOS SwiftUI](https://github.com/Tencent-RTC/TUIKit_iOS_SwiftUI/blob/main/chat/demo/ChatDemo/appConfig.json) 项目为例，appConfig.json 位于 demo/ChatDemo 的主 bundle 下：
+以 GitHub 开源 Demo [TUIKit iOS SwiftUI](https://github.com/Tencent-RTC/TUIKit_iOS_SwiftUI/blob/main/chat/demo/ChatDemo/appConfig.json) 项目为例，appConfig.json 位于 demo/ChatDemo 的主 bundle 下：
 
 #### 步骤3：加载配置文件
 
@@ -223,45 +226,45 @@ struct CustomColorPicker: View {
 > - 在整个应用中统一使用 `themeState.colors` 中的颜色，确保主题切换时界面保持一致。
 
 ## 常见问题
-- **如何判断当前是否为深色模式？**
 
-   ``` swift
-   if themeState.isDarkMode {
-       // 当前是深色模式
-   } else {
-       // 当前是浅色模式
-   }
-   ```
-- **如何在设置主题色后立即看到效果？**
+### **如何判断当前是否为深色模式？**
+``` swift
+if themeState.isDarkMode {
+    // 当前是深色模式
+} else {
+    // 当前是浅色模式
+}
+```
 
-   主题色设置后会自动刷新 UI，因为 `ThemeState` 是 `ObservableObject`。确保您的视图使用了 `@EnvironmentObject` 或 `@ObservedObject` 来观察状态变化。
+### **如何在设置主题色后立即看到效果？**
 
-- **可以设置透明度吗？**
+主题色设置后会自动刷新 UI，因为 `ThemeState` 是 `ObservableObject`。确保您的视图使用了 `@EnvironmentObject` 或 `@ObservedObject` 来观察状态变化。
 
-   不支持。主题色只支持 6 位 Hex 格式（RGB），不支持 8 位格式（RGBA）。如需透明效果，请在使用颜色时添加 `.opacity()` 修饰符。
+### **可以设置透明度吗？**
 
-- **如何恢复默认主题？**
+不支持。主题色只支持 6 位 Hex 格式（RGB），不支持 8 位格式（RGBA）。如需透明效果，请在使用颜色时添加 `.opacity()` 修饰符。
 
-   ``` swift
-   themeState.clearPrimaryColor()  // 清除自定义主题色
-   themeState.setThemeMode(.system) // 恢复跟随系统
-   ```
-- **主题配置存储在哪里？**
+### **如何恢复默认主题？**
+``` swift
+themeState.clearPrimaryColor()  // 清除自定义主题色
+themeState.setThemeMode(.system) // 恢复跟随系统
+```
 
-   存储在 `UserDefaults` 中，key 为 `"BaseComponentThemeKey"`。应用卸载后会丢失，重新安装后恢复默认配置。
+### **主题配置存储在哪里？**
 
-- **如何获取当前主题的完整配置？**
+存储在 `UserDefaults` 中，key 为 `"BaseComponentThemeKey"`。应用卸载后会丢失，重新安装后恢复默认配置。
 
-   ``` swift
-   let config = themeState.currentTheme
-   print("模式: \(config.mode)")
-   print("主题色: \(config.primaryColor ?? "默认")")
-   ```
-- **可以同时设置模式和主题色吗？**
+### **如何获取当前主题的完整配置？**
+``` swift
+let config = themeState.currentTheme
+print("模式: \(config.mode)")
+print("主题色: \(config.primaryColor ?? "默认")")
+```
 
-   可以分别调用两个方法，系统会自动合并配置：
+### **可以同时设置模式和主题色吗？**
 
-   ``` swift
-   themeState.setThemeMode(.dark)
-   themeState.setPrimaryColor("#0ABF77")
-   ```
+可以分别调用两个方法，系统会自动合并配置：
+``` swift
+themeState.setThemeMode(.dark)
+themeState.setPrimaryColor("#0ABF77")
+```