diff --git a/components/tree/index.en-US.md b/components/tree/index.en-US.md index 61cdb1438..c3e64fdaf 100644 --- a/components/tree/index.en-US.md +++ b/components/tree/index.en-US.md @@ -20,6 +20,7 @@ | expandedKeys(.sync) | (Controlled) Specifies the keys of the expanded treeNodes | string\[] | \[] | | filterTreeNode | Defines a function to filter (highlight) treeNodes. When the function returns `true`, the corresponding treeNode will be highlighted | function(node) | - | | loadData | Load data asynchronously | function(node) | - | +| loadedKeys | (Controlled) Set loaded tree nodes. Need work with `loadData` | string\[] | \[] | | multiple | Allows selecting multiple treeNodes | boolean | false | | selectedKeys(.sync) | (Controlled) Specifies the keys of the selected treeNodes | string\[] | - | | showIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true` | boolean | false | @@ -28,16 +29,17 @@ ### Events | Events Name | Description | Arguments | | --- | --- | --- | -| check | Callback function for when the onCheck event occurs | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | -| dragEnd | Callback function for when the onDragEnd event occurs | function({event, node}) | - | -| dragEnter | Callback function for when the onDragEnter event occurs | function({event, node, expandedKeys}) | - | -| dragLeave | Callback function for when the onDragLeave event occurs | function({event, node}) | - | -| dragOver | Callback function for when the onDragOver event occurs | function({event, node}) | - | -| dragStart | Callback function for when the onDragStart event occurs | function({event, node}) | - | -| drop | Callback function for when the onDrop event occurs | function({event, node, dragNode, dragNodesKeys}) | - | -| expand | Callback function for when a treeNode is expanded or collapsed | function(expandedKeys, {expanded: bool, node}) | - | -| rightClick | Callback function for when the user right clicks a treeNode | function({event, node}) | - | -| select | Callback function for when the user clicks a treeNode | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | +| check | Callback function for when the onCheck event occurs | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | +| dragEnd | Callback function for when the onDragEnd event occurs | function({event, node}) | +| dragEnter | Callback function for when the onDragEnter event occurs | function({event, node, expandedKeys}) | +| dragLeave | Callback function for when the onDragLeave event occurs | function({event, node}) | +| dragOver | Callback function for when the onDragOver event occurs | function({event, node}) | +| dragStart | Callback function for when the onDragStart event occurs | function({event, node}) | +| drop | Callback function for when the onDrop event occurs | function({event, node, dragNode, dragNodesKeys}) | +| expand | Callback function for when a treeNode is expanded or collapsed | function(expandedKeys, {expanded: bool, node}) | +| load | Callback function for when a treeNode is loaded | function(loadedKeys, {event, node}) | +| rightClick | Callback function for when the user right clicks a treeNode | function({event, node}) | +| select | Callback function for when the user clicks a treeNode | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | ### TreeNode props @@ -59,3 +61,8 @@ One of the Tree `treeNode` prop for describing the tree's node, TreeNode has the | scopedSlots | When using treeNodes, you can use this property to configure the properties that support the slot-scope, such as `scopedSlots: { title: 'XXX'}` | object | - | | on | When using treeNodes, you can use this property to configure the events, such as `on: { click: () => {}}` | object | - | +### DirectoryTree props + +| Property | Description | Type | Default | +| --- | --- | --- | --- | +| expandAction | Directory open logic, optional `false` `'click'` `'doubleclick'` | string | click | diff --git a/components/tree/index.zh-CN.md b/components/tree/index.zh-CN.md index d77856e44..76ef142e3 100644 --- a/components/tree/index.zh-CN.md +++ b/components/tree/index.zh-CN.md @@ -5,7 +5,7 @@ | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| treeNodes | 节点的配置描述,具体项见下表 | array | -- | +| treeData | 节点的配置描述,具体项见下表, 1.1.4之前的版本使用`treeNodes` | array | -- | | autoExpandParent | 是否自动展开父节点 | boolean | true | | checkable | 节点前添加 Checkbox 复选框 | boolean | false | | checkedKeys(v-model) | (受控)选中复选框的树节点(注意:父子节点有关联,如果传入父节点key,则子节点自动选中;相应当子节点key都传入,父节点也自动选中。当设置`checkable`和`checkStrictly`,它是一个有`checked`和`halfChecked`属性的对象,并且父子节点的选中与否不再关联 | string\[] \| {checked: string\[], halfChecked: string\[]} | \[] | @@ -20,6 +20,7 @@ | expandedKeys(.sync) | (受控)展开指定的树节点 | string\[] | \[] | | filterTreeNode | 按需筛选树节点(高亮),返回true | function(node) | - | | loadData | 异步加载数据 | function(node) | - | +| loadedKeys | (受控)已经加载的节点,需要配合 `loadData` 使用 | string\[] | \[] | | multiple | 支持点选多个节点(节点本身) | boolean | false | | selectedKeys(.sync) | (受控)设置选中的树节点 | string\[] | - | | showIcon | 是否展示 TreeNode title 前的图标,没有默认样式,如设置为 true,需要自行定义图标相关样式 | boolean | false | @@ -30,16 +31,17 @@ | 事件名称 | 说明 | 回调参数 | | --- | --- | --- | -| check | 点击复选框触发 | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | -| dragEnd | dragend 触发时调用 | function({event, node}) | - | -| dragEnter | dragenter 触发时调用 | function({event, node, expandedKeys}) | - | -| dragLeave | dragleave 触发时调用 | function({event, node}) | - | -| dragOver | dragover 触发时调用 | function({event, node}) | - | -| dragStart | 开始拖拽时调用 | function({event, node}) | - | -| drop | drop 触发时调用 | function({event, node, dragNode, dragNodesKeys}) | - | -| expand | 展开/收起节点时触发 | function(expandedKeys, {expanded: bool, node}) | - | -| rightClick | 响应右键点击 | function({event, node}) | - | -| select | 点击树节点触发 | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | +| check | 点击复选框触发 | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | +| dragEnd | dragend 触发时调用 | function({event, node}) | +| dragEnter | dragenter 触发时调用 | function({event, node, expandedKeys}) | +| dragLeave | dragleave 触发时调用 | function({event, node}) | +| dragOver | dragover 触发时调用 | function({event, node}) | +| dragStart | 开始拖拽时调用 | function({event, node}) | +| drop | drop 触发时调用 | function({event, node, dragNode, dragNodesKeys}) | +| expand | 展开/收起节点时触发 | function(expandedKeys, {expanded: bool, node}) | +| load | 节点加载完毕时触发 | function(loadedKeys, {event, node}) | +| rightClick | 响应右键点击 | function({event, node}) | +| select | 点击树节点触发 | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | ### TreeNode props @@ -60,5 +62,11 @@ | scopedSlots | 使用columns时,可以通过该属性配置支持slot-scope的属性,如 `scopedSlots: { title: 'XXX'}` | object | - | | on | 事件对象,仅在treeNodes使用方式中生效,如`{click: () => {}}` | object | '---' | +### DirectoryTree props + +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| expandAction | 目录展开逻辑,可选 `false` `'click'` `'doubleclick'` | string | click | + diff --git a/components/vc-tree/src/Tree.jsx b/components/vc-tree/src/Tree.jsx index 7e1c09216..68e99a8bd 100644 --- a/components/vc-tree/src/Tree.jsx +++ b/components/vc-tree/src/Tree.jsx @@ -525,7 +525,7 @@ const Tree = { onNodeContextMenu (event, node) { event.preventDefault() - this.__emit('rightclick', { event, node }) + this.__emit('rightClick', { event, node }) }, /**