feat: refresh function to tree

TDesignOteam · Feb 7, 2024 · 057deb5 · 057deb5
1 parent 3341054
commit 057deb5
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 0 deletions.
diff --git a/db/TDesign.db b/db/TDesign.db
diff --git a/packages/products/tdesign-react/src/tree/tree.en-US.md b/packages/products/tdesign-react/src/tree/tree.en-US.md
@@ -69,6 +69,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | required
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | required。get tree struct data
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | required
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | required
+refresh | \- | \- | required。refresh tree state, used in tree search
 remove | `(value: TreeNodeValue)` | \- | required
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | support scrolling to a specific node when virtual scrolling 
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | required

diff --git a/packages/products/tdesign-react/src/tree/tree.md b/packages/products/tdesign-react/src/tree/tree.md
@@ -69,6 +69,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | 必需。自下而
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | 必需。获取某节点的全部树形结构；参数为空，则表示获取整棵树的结构数据，泛型 `T` 表示树节点 TS 类型
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点后面，泛型 `T` 表示树节点 TS 类型
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
+refresh | \- | \- | 必需。刷新树节点状态，可用于搜索场景刷新
 remove | `(value: TreeNodeValue)` | \- | 必需。移除指定节点
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | 虚拟滚动场景下 支持指定滚动到具体的节点
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | 必需。设置节点状态

diff --git a/packages/products/tdesign-react/src/tree/type.ts b/packages/products/tdesign-react/src/tree/type.ts
@@ -282,6 +282,10 @@ export interface TreeInstanceFunctions<T extends TreeOptionData = TreeOptionData
    * 插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
    */
   insertBefore: (value: TreeNodeValue, newData: T) => void;
+  /**
+   * 刷新树节点状态，可用于搜索场景刷新
+   */
+  refresh: () => void;
   /**
    * 移除指定节点
    */

diff --git a/packages/products/tdesign-vue-next/src/tree/tree.en-US.md b/packages/products/tdesign-vue-next/src/tree/tree.en-US.md
@@ -81,6 +81,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | required
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | required。get tree struct data
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | required
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | required
+refresh | \- | \- | required。refresh tree state, used in tree search
 remove | `(value: TreeNodeValue)` | \- | required
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | support scrolling to a specific node when virtual scrolling 
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | required

diff --git a/packages/products/tdesign-vue-next/src/tree/tree.md b/packages/products/tdesign-vue-next/src/tree/tree.md
@@ -81,6 +81,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | 必需。自下而
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | 必需。获取某节点的全部树形结构；参数为空，则表示获取整棵树的结构数据，泛型 `T` 表示树节点 TS 类型
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点后面，泛型 `T` 表示树节点 TS 类型
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
+refresh | \- | \- | 必需。刷新树节点状态，可用于搜索场景刷新
 remove | `(value: TreeNodeValue)` | \- | 必需。移除指定节点
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | 虚拟滚动场景下 支持指定滚动到具体的节点
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | 必需。设置节点状态

diff --git a/packages/products/tdesign-vue-next/src/tree/type.ts b/packages/products/tdesign-vue-next/src/tree/type.ts
@@ -282,6 +282,10 @@ export interface TreeInstanceFunctions<T extends TreeOptionData = TreeOptionData
    * 插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
    */
   insertBefore: (value: TreeNodeValue, newData: T) => void;
+  /**
+   * 刷新树节点状态，可用于搜索场景刷新
+   */
+  refresh: () => void;
   /**
    * 移除指定节点
    */

diff --git a/packages/products/tdesign-vue/src/tree/tree.en-US.md b/packages/products/tdesign-vue/src/tree/tree.en-US.md
@@ -81,6 +81,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | required
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | required。get tree struct data
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | required
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | required
+refresh | \- | \- | required。refresh tree state, used in tree search
 remove | `(value: TreeNodeValue)` | \- | required
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | support scrolling to a specific node when virtual scrolling 
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | required

diff --git a/packages/products/tdesign-vue/src/tree/tree.md b/packages/products/tdesign-vue/src/tree/tree.md
@@ -81,6 +81,7 @@ getPath | `(value: TreeNodeValue)` | `TreeNodeModel<T>[]` | 必需。自下而
 getTreeData | `(value?: TreeNodeValue)` | `Array<T>` | 必需。获取某节点的全部树形结构；参数为空，则表示获取整棵树的结构数据，泛型 `T` 表示树节点 TS 类型
 insertAfter | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点后面，泛型 `T` 表示树节点 TS 类型
 insertBefore | `(value: TreeNodeValue, newData: T)` | \- | 必需。插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
+refresh | \- | \- | 必需。刷新树节点状态，可用于搜索场景刷新
 remove | `(value: TreeNodeValue)` | \- | 必需。移除指定节点
 scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | 虚拟滚动场景下 支持指定滚动到具体的节点
 setItem | `(value: TreeNodeValue, options: TreeNodeState)` | \- | 必需。设置节点状态

diff --git a/packages/products/tdesign-vue/src/tree/type.ts b/packages/products/tdesign-vue/src/tree/type.ts
@@ -277,6 +277,10 @@ export interface TreeInstanceFunctions<T extends TreeOptionData = TreeOptionData
    * 插入新节点到指定节点前面，泛型 `T` 表示树节点 TS 类型
    */
   insertBefore: (value: TreeNodeValue, newData: T) => void;
+  /**
+   * 刷新树节点状态，可用于搜索场景刷新
+   */
+  refresh: () => void;
   /**
    * 移除指定节点
    */

diff --git a/packages/scripts/api.json b/packages/scripts/api.json
@@ -113181,6 +113181,43 @@
       ],
       "field_type_text": []
     },
+    {
+      "id": 1707275700,
+      "platform_framework": [
+        "1",
+        "2",
+        "4"
+      ],
+      "component": "Tree",
+      "field_category": 4,
+      "field_name": "refresh",
+      "field_type": [],
+      "field_default_value": "",
+      "field_enum": "",
+      "field_desc_zh": "刷新树节点状态，可用于搜索场景刷新",
+      "field_desc_en": "refresh tree state, used in tree search",
+      "field_required": 1,
+      "event_input": "",
+      "create_time": "2024-02-07 03:15:00",
+      "update_time": "2024-02-07 03:15:00",
+      "event_output": null,
+      "custom_field_type": null,
+      "syntactic_sugar": null,
+      "readonly": 1,
+      "html_attribute": 0,
+      "trigger_elements": "",
+      "deprecated": 0,
+      "version": "",
+      "test_description": null,
+      "support_default_value": 0,
+      "field_category_text": "Functions",
+      "platform_framework_text": [
+        "Vue(PC)",
+        "React(PC)",
+        "Angular(PC)"
+      ],
+      "field_type_text": []
+    },
     {
       "id": 569,
       "platform_framework": [