Skip to content

Commit

Permalink
docs(tree): update valueMode desc (#438)
Browse files Browse the repository at this point in the history
  • Loading branch information
liweijie0812 authored Sep 30, 2024
1 parent 6aa92a0 commit d88314c
Show file tree
Hide file tree
Showing 10 changed files with 9 additions and 9 deletions.
Binary file modified db/TDesign.db
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/tree/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ scroll | Object | - | 懒加载和虚拟滚动。为保证组件收益最大化
transition | Boolean | true | 节点展开折叠时是否使用过渡动画 | N
value | Array | [] | 选中值,组件为可选状态时有效。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/tree/type.ts) | N
defaultValue | Array | [] | 选中值,组件为可选状态时有效。非受控属性。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/tree/type.ts) | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
onActive | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点激活时触发,泛型 `T` 表示树节点 TS 类型 | N
onChange | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点选中状态变化时触发,context.node 表示当前变化的选项,泛型 `T` 表示树节点 TS 类型 | N
onClick | Function | | TS 类型:`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/>节点点击时触发,泛型 `T` 表示树节点 TS 类型 | N
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/tree/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
*/
defaultValue?: Array<TreeNodeValue>;
/**
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点
* @default onlyLeaf
*/
valueMode?: 'onlyLeaf' | 'parentFirst' | 'all';
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/tree/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ export default {
type: Array as PropType<TdTreeProps['defaultValue']>,
default: (): TdTreeProps['defaultValue'] => [],
},
/** 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点 */
/** 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点 */
valueMode: {
type: String as PropType<TdTreeProps['valueMode']>,
default: 'onlyLeaf' as TdTreeProps['valueMode'],
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/tree/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ scroll | Object | - | 懒加载和虚拟滚动。为保证组件收益最大化
transition | Boolean | true | 节点展开折叠时是否使用过渡动画 | N
value | Array | [] | 选中值,组件为可选状态时有效。支持语法糖 `v-model``v-model:value`。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tree/type.ts) | N
defaultValue | Array | [] | 选中值,组件为可选状态时有效。非受控属性。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tree/type.ts) | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
onActive | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点激活时触发,泛型 `T` 表示树节点 TS 类型 | N
onChange | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点选中状态变化时触发,context.node 表示当前变化的选项,泛型 `T` 表示树节点 TS 类型 | N
onClick | Function | | TS 类型:`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/>节点点击时触发,泛型 `T` 表示树节点 TS 类型 | N
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/tree/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
*/
modelValue?: Array<TreeNodeValue>;
/**
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点
* @default onlyLeaf
*/
valueMode?: 'onlyLeaf' | 'parentFirst' | 'all';
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/tree/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export default {
type: Array as PropType<TdTreeProps['defaultValue']>,
default: (): TdTreeProps['defaultValue'] => [],
},
/** 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点 */
/** 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点 */
valueMode: {
type: String as PropType<TdTreeProps['valueMode']>,
default: 'onlyLeaf' as TdTreeProps['valueMode'],
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/tree/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ scroll | Object | - | 懒加载和虚拟滚动。为保证组件收益最大化
transition | Boolean | true | 节点展开折叠时是否使用过渡动画 | N
value | Array | [] | 选中值,组件为可选状态时有效。支持语法糖 `v-model`。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
defaultValue | Array | [] | 选中值,组件为可选状态时有效。非受控属性。TS 类型:`Array<TreeNodeValue>` `type TreeNodeValue = string \| number`[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tree/type.ts) | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
valueMode | String | onlyLeaf | 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点。可选项:onlyLeaf/parentFirst/all | N
onActive | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点激活时触发,泛型 `T` 表示树节点 TS 类型 | N
onChange | Function | | TS 类型:`(value: Array<TreeNodeValue>, context: { node: TreeNodeModel<T>; e?: any; trigger: 'node-click' \| 'setItem' }) => void`<br/>节点选中状态变化时触发,context.node 表示当前变化的选项,泛型 `T` 表示树节点 TS 类型 | N
onClick | Function | | TS 类型:`(context: { node: TreeNodeModel<T>; e: MouseEvent }) => void`<br/>节点点击时触发,泛型 `T` 表示树节点 TS 类型 | N
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/tree/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export interface TdTreeProps<T extends TreeOptionData = TreeOptionData> {
*/
defaultValue?: Array<TreeNodeValue>;
/**
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点
* 选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点
* @default onlyLeaf
*/
valueMode?: 'onlyLeaf' | 'parentFirst' | 'all';
Expand Down
2 changes: 1 addition & 1 deletion packages/scripts/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -128440,7 +128440,7 @@
],
"field_default_value": "onlyLeaf",
"field_enum": "onlyLeaf/parentFirst/all",
"field_desc_zh": "选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaft 表示无论什么情况,选中值仅呈现叶子节点",
"field_desc_zh": "选中值模式。all 表示父节点和子节点全部会出现在选中值里面;parentFirst 表示当子节点全部选中时,仅父节点在选中值里面;onlyLeaf 表示无论什么情况,选中值仅呈现叶子节点",
"field_desc_en": null,
"field_required": 0,
"event_input": "",
Expand Down

0 comments on commit d88314c

Please sign in to comment.