chore: update tree docs

TDesignOteam · Jul 12, 2023 · ee40b67 · ee40b67
1 parent 11f8a8e
commit ee40b67
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 18 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
@@ -10,7 +10,6 @@ style | Object | - | 样式，Typescript：`React.CSSProperties` | N
 activable | Boolean | false | \- | N
 activeMultiple | Boolean | false | \- | N
 actived | Array | - | Typescript：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | uncontrolled property。Typescript：`Array<TreeNodeValue>` | 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/src/tree/type.ts) | N
 checkStrictly | Boolean | false | \- | N
@@ -26,7 +25,6 @@ expandMutex | Boolean | false | \- | N
 expandOnClickNode | Boolean | false | \- | N
 expandParent | Boolean | false | \- | N
 expanded | Array | [] | Typescript：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` | N
 filter | Function | - | Typescript：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | table height | N
 hover | Boolean | - | \- | N
@@ -42,7 +40,7 @@ scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[s
 transition | Boolean | true | \- | N
 value | Array | [] | Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/tree/type.ts) | N
 defaultValue | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/tree/type.ts) | N
-valueMode | String | onlyLeaf | options：onlyLeaf/parentFirst/all | N
+valueMode | String | onlyLeaf | options: onlyLeaf/parentFirst/all | N
 onActive | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onChange | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onClick | Function |  | Typescript：`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/> | N
@@ -131,4 +129,4 @@ bufferSize | Number | 20 | \- | N
 isFixedRowHeight | Boolean | false | \- | N
 rowHeight | Number | - | \- | N
 threshold | Number | 100 | \- | N
-type | String | - | required。options：lazy/virtual | Y
+type | String | - | required。options: lazy/virtual | Y
diff --git a/packages/products/tdesign-react/src/tree/tree.md b/packages/products/tdesign-react/src/tree/tree.md
@@ -10,7 +10,6 @@ style | Object | - | 样式，TS 类型：`React.CSSProperties` | N
 activable | Boolean | false | 节点是否可高亮 | N
 activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。TS 类型：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | 高亮的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | 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/src/tree/type.ts) | N
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
@@ -26,7 +25,6 @@ expandMutex | Boolean | false | 同级别展开互斥，手风琴效果 | N
 expandOnClickNode | Boolean | false | 是否支持点击节点也能展开收起 | N
 expandParent | Boolean | false | 展开子节点时是否自动展开父节点 | N
 expanded | Array | [] | 展开的节点值。TS 类型：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | 展开的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | N
 filter | Function | - | 节点过滤方法，只呈现返回值为 true 的节点，泛型 `T` 表示树节点 TS 类型。TS 类型：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | 表格高度，超出后会出现滚动条。示例：100,  '30%',  '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight` | N
 hover | Boolean | - | 节点是否有悬浮状态 | N

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
@@ -8,7 +8,6 @@ name | type | default | description | required
 activable | Boolean | false | \- | N
 activeMultiple | Boolean | false | \- | N
 actived | Array | - | `v-model:actived` is supported。Typescript：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | uncontrolled property。Typescript：`Array<TreeNodeValue>` | 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/tree/develop/src/tree/type.ts) | N
 checkStrictly | Boolean | false | \- | N
@@ -24,7 +23,6 @@ expandMutex | Boolean | false | \- | N
 expandOnClickNode | Boolean | false | \- | N
 expandParent | Boolean | false | \- | N
 expanded | Array | [] | `v-model:expanded` is supported。Typescript：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` | N
 filter | Function | - | Typescript：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | table height | N
 hover | Boolean | - | \- | N
@@ -40,7 +38,7 @@ scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[s
 transition | Boolean | true | \- | N
 value | Array | [] | `v-model` and `v-model:value` is supported。Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tree/type.ts) | N
 defaultValue | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tree/type.ts) | N
-valueMode | String | onlyLeaf | options：onlyLeaf/parentFirst/all | N
+valueMode | String | onlyLeaf | options: onlyLeaf/parentFirst/all | N
 onActive | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onChange | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onClick | Function |  | Typescript：`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/> | N
@@ -143,4 +141,4 @@ bufferSize | Number | 20 | \- | N
 isFixedRowHeight | Boolean | false | \- | N
 rowHeight | Number | - | \- | N
 threshold | Number | 100 | \- | N
-type | String | - | required。options：lazy/virtual | Y
+type | String | - | required。options: lazy/virtual | Y
diff --git a/packages/products/tdesign-vue-next/src/tree/tree.md b/packages/products/tdesign-vue-next/src/tree/tree.md
@@ -8,7 +8,6 @@
 activable | Boolean | false | 节点是否可高亮 | N
 activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。支持语法糖 `v-model:actived`。TS 类型：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | 高亮的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | 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/tree/develop/src/tree/type.ts) | N
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
@@ -24,7 +23,6 @@ expandMutex | Boolean | false | 同级别展开互斥，手风琴效果 | N
 expandOnClickNode | Boolean | false | 是否支持点击节点也能展开收起 | N
 expandParent | Boolean | false | 展开子节点时是否自动展开父节点 | N
 expanded | Array | [] | 展开的节点值。支持语法糖 `v-model:expanded`。TS 类型：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | 展开的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | N
 filter | Function | - | 节点过滤方法，只呈现返回值为 true 的节点，泛型 `T` 表示树节点 TS 类型。TS 类型：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | 表格高度，超出后会出现滚动条。示例：100,  '30%',  '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight` | N
 hover | Boolean | - | 节点是否有悬浮状态 | N

diff --git a/packages/products/tdesign-vue/src/tree/tree.en-US.md b/packages/products/tdesign-vue/src/tree/tree.en-US.md
@@ -8,7 +8,6 @@ name | type | default | description | required
 activable | Boolean | false | \- | N
 activeMultiple | Boolean | false | \- | N
 actived | Array | - | `.sync` is supported。Typescript：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | uncontrolled property。Typescript：`Array<TreeNodeValue>` | 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
 checkStrictly | Boolean | false | \- | N
@@ -24,7 +23,6 @@ expandMutex | Boolean | false | \- | N
 expandOnClickNode | Boolean | false | \- | N
 expandParent | Boolean | false | \- | N
 expanded | Array | [] | `.sync` is supported。Typescript：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` | N
 filter | Function | - | Typescript：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | table height | N
 hover | Boolean | - | \- | N
@@ -40,7 +38,7 @@ scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[s
 transition | Boolean | true | \- | N
 value | Array | [] | `v-model` is supported。Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
 defaultValue | Array | [] | uncontrolled property。Typescript：`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
-valueMode | String | onlyLeaf | options：onlyLeaf/parentFirst/all | N
+valueMode | String | onlyLeaf | options: onlyLeaf/parentFirst/all | N
 onActive | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onChange | Function |  | Typescript：`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/> | N
 onClick | Function |  | Typescript：`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/> | N
@@ -143,4 +141,4 @@ bufferSize | Number | 20 | \- | N
 isFixedRowHeight | Boolean | false | \- | N
 rowHeight | Number | - | \- | N
 threshold | Number | 100 | \- | N
-type | String | - | required。options：lazy/virtual | Y
+type | String | - | required。options: lazy/virtual | Y
diff --git a/packages/products/tdesign-vue/src/tree/tree.md b/packages/products/tdesign-vue/src/tree/tree.md
@@ -8,7 +8,6 @@
 activable | Boolean | false | 节点是否可高亮 | N
 activeMultiple | Boolean | false | 是否允许多个节点同时高亮 | N
 actived | Array | - | 高亮的节点值。支持语法糖 `.sync`。TS 类型：`Array<TreeNodeValue>` | N
-defaultActived | Array | - | 高亮的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | 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
 checkStrictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
@@ -24,7 +23,6 @@ expandMutex | Boolean | false | 同级别展开互斥，手风琴效果 | N
 expandOnClickNode | Boolean | false | 是否支持点击节点也能展开收起 | N
 expandParent | Boolean | false | 展开子节点时是否自动展开父节点 | N
 expanded | Array | [] | 展开的节点值。支持语法糖 `.sync`。TS 类型：`Array<TreeNodeValue>` | N
-defaultExpanded | Array | [] | 展开的节点值。非受控属性。TS 类型：`Array<TreeNodeValue>` | N
 filter | Function | - | 节点过滤方法，只呈现返回值为 true 的节点，泛型 `T` 表示树节点 TS 类型。TS 类型：`(node: TreeNodeModel<T>) => boolean` | N
 height | String / Number | - | 表格高度，超出后会出现滚动条。示例：100,  '30%',  '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight` | N
 hover | Boolean | - | 节点是否有悬浮状态 | N