feat(Tree): allow checkProps to be a function (#600)

RylanBot · web-flow · commit 0cc14c440209 · 2025-04-14T14:01:57.000+08:00
diff --git a/db/TDesign.db b/db/TDesign.db
diff --git a/packages/products/tdesign-react/packages/components/tree/tree.en-US.md b/packages/products/tdesign-react/packages/components/tree/tree.en-US.md
@@ -13,7 +13,7 @@ activeMultiple | Boolean | false | \- | N
 actived | Array | - | Typescript：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | Determine whether the node can execute the drop operation。Typescript：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | \- | N
-checkProps | Object | - | Typescript：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N
+checkProps | Object / Function | - | Typescript：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N
 checkStrictly | Boolean | false | \- | N
 checkable | Boolean | false | \- | N
 data | Array | [] | Typescript：`Array<T>` | N
diff --git a/packages/products/tdesign-react/packages/components/tree/tree.md b/packages/products/tdesign-react/packages/components/tree/tree.md
@@ -13,7 +13,7 @@ activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。TS 类型：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | 判断节点是否可以执行 drop 操作，泛型 `T` 表示树节点 TS 类型。TS 类型：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | 是否允许在过滤时节点折叠节点 | N
-checkProps | Object | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N
+checkProps | Object / Function | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
 checkable | Boolean | false | 隐藏节点复选框 | N
 data | Array | [] | 树数据，泛型 `T` 表示树节点 TS 类型。TS 类型：`Array<T>` | N
diff --git a/packages/products/tdesign-react/packages/components/tree/type.ts b/packages/products/tdesign-react/packages/components/tree/type.ts
@@ -44,7 +44,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
   /**
    * 透传属性到 checkbox 组件。参考 checkbox 组件 API
    */
-  checkProps?: CheckboxProps;
+  checkProps?: CheckboxProps | ((node: TreeNodeModel<T>) => CheckboxProps);
   /**
    * 父子节点选中状态不再关联，可各自选中或取消
    * @default false
diff --git a/packages/products/tdesign-vue-next/packages/components/tree/props.ts b/packages/products/tdesign-vue-next/packages/components/tree/props.ts
@@ -29,7 +29,7 @@ export default {
   allowFoldNodeOnFilter: Boolean,
   /** 透传属性到 checkbox 组件。参考 checkbox 组件 API */
   checkProps: {
-    type: Object as PropType<TdTreeProps['checkProps']>,
+    type: [Object, Function] as PropType<TdTreeProps['checkProps']>,
   },
   /** 父子节点选中状态不再关联，可各自选中或取消 */
   checkStrictly: Boolean,
diff --git a/packages/products/tdesign-vue-next/packages/components/tree/tree.en-US.md b/packages/products/tdesign-vue-next/packages/components/tree/tree.en-US.md
@@ -11,7 +11,7 @@ activeMultiple | Boolean | false | \- | N
 actived | Array | - | `v-model:actived` is supported。Typescript：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | Determine whether the node can execute the drop operation。Typescript：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | \- | N
-checkProps | Object | - | Typescript：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/tree/type.ts) | N
+checkProps | Object / Function | - | Typescript：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/tree/type.ts) | N
 checkStrictly | Boolean | false | \- | N
 checkable | Boolean | false | \- | N
 data | Array | [] | Typescript：`Array<T>` | N
diff --git a/packages/products/tdesign-vue-next/packages/components/tree/tree.md b/packages/products/tdesign-vue-next/packages/components/tree/tree.md
@@ -11,7 +11,7 @@ activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。支持语法糖 `v-model:actived`。TS 类型：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | 判断节点是否可以执行 drop 操作，泛型 `T` 表示树节点 TS 类型。TS 类型：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | 是否允许在过滤时节点折叠节点 | N
-checkProps | Object | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/tree/type.ts) | N
+checkProps | Object / Function | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/tree/type.ts) | N
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
 checkable | Boolean | false | 隐藏节点复选框 | N
 data | Array | [] | 树数据，泛型 `T` 表示树节点 TS 类型。TS 类型：`Array<T>` | N
diff --git a/packages/products/tdesign-vue-next/packages/components/tree/type.ts b/packages/products/tdesign-vue-next/packages/components/tree/type.ts
@@ -43,7 +43,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
   /**
    * 透传属性到 checkbox 组件。参考 checkbox 组件 API
    */
-  checkProps?: CheckboxProps;
+  checkProps?: CheckboxProps | ((node: TreeNodeModel<T>) => CheckboxProps);
   /**
    * 父子节点选中状态不再关联，可各自选中或取消
    * @default false
diff --git a/packages/products/tdesign-vue/src/tree/props.ts b/packages/products/tdesign-vue/src/tree/props.ts
@@ -28,7 +28,7 @@ export default {
   allowFoldNodeOnFilter: Boolean,
   /** 透传属性到 checkbox 组件。参考 checkbox 组件 API */
   checkProps: {
-    type: Object as PropType<TdTreeProps['checkProps']>,
+    type: [Object, Function] as PropType<TdTreeProps['checkProps']>,
   },
   /** 父子节点选中状态不再关联，可各自选中或取消 */
   checkStrictly: Boolean,
diff --git a/packages/products/tdesign-vue/src/tree/tree.en-US.md b/packages/products/tdesign-vue/src/tree/tree.en-US.md
@@ -11,7 +11,7 @@ activeMultiple | Boolean | false | \- | N
 actived | Array | - | `.sync` is supported。Typescript：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | Determine whether the node can execute the drop operation。Typescript：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | \- | N
-checkProps | Object | - | Typescript：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
+checkProps | Object / Function | - | Typescript：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
 checkStrictly | Boolean | false | \- | N
 checkable | Boolean | false | \- | N
 data | Array | [] | Typescript：`Array<T>` | N
diff --git a/packages/products/tdesign-vue/src/tree/tree.md b/packages/products/tdesign-vue/src/tree/tree.md
@@ -11,7 +11,7 @@ activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。支持语法糖 `.sync`。TS 类型：`Array<TreeNodeValue>` | N
 allowDrop | Function | - | 判断节点是否可以执行 drop 操作，泛型 `T` 表示树节点 TS 类型。TS 类型：`(context: { e: DragEvent; dragNode: TreeNodeModel<T>; dropNode: TreeNodeModel<T>; dropPosition: number; }) => boolean` | N
 allowFoldNodeOnFilter | Boolean | false | 是否允许在过滤时节点折叠节点 | N
-checkProps | Object | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
+checkProps | Object / Function | - | 透传属性到 checkbox 组件。参考 checkbox 组件 API。TS 类型：`CheckboxProps \| ((node: TreeNodeModel<T>) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
 checkable | Boolean | false | 隐藏节点复选框 | N
 data | Array | [] | 树数据，泛型 `T` 表示树节点 TS 类型。TS 类型：`Array<T>` | N
diff --git a/packages/products/tdesign-vue/src/tree/type.ts b/packages/products/tdesign-vue/src/tree/type.ts
@@ -43,7 +43,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
   /**
    * 透传属性到 checkbox 组件。参考 checkbox 组件 API
    */
-  checkProps?: CheckboxProps;
+  checkProps?: CheckboxProps | ((node: TreeNodeModel<T>) => CheckboxProps);
   /**
    * 父子节点选中状态不再关联，可各自选中或取消
    * @default false
diff --git a/packages/scripts/api.json b/packages/scripts/api.json
@@ -133598,17 +133598,14 @@
       "id": 526,
       "platform_framework": [
         "1",
-        "2",
-        "4",
-        "16",
-        "32",
-        "64"
+        "2"
       ],
       "component": "Tree",
       "field_category": 1,
       "field_name": "checkProps",
       "field_type": [
-        "8"
+        "8",
+        "32"
       ],
       "field_default_value": "",
       "field_enum": "",
@@ -133619,7 +133616,7 @@
       "create_time": "2020-12-28 06:11:52",
       "update_time": "2021-03-15 15:33:12",
       "event_output": null,
-      "custom_field_type": "CheckboxProps【import { CheckboxProps } from '@Checkbox'】",
+      "custom_field_type": "CheckboxProps | ((node: TreeNodeModel<T>) => CheckboxProps)【import { CheckboxProps } from '@Checkbox'】",
       "syntactic_sugar": null,
       "readonly": 1,
       "html_attribute": 0,
@@ -133631,14 +133628,11 @@
       "field_category_text": "Props",
       "platform_framework_text": [
         "Vue(PC)",
-        "React(PC)",
-        "Angular(PC)",
-        "React(Mobile)",
-        "Angular(Mobile)",
-        "Miniprogram"
+        "React(PC)"
       ],
       "field_type_text": [
-        "Object"
+        "Object",
+        "Function"
       ]
     },
     {
