From 273f6969d3faab58cda8fa30844a6e624809a2dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=B1=9F=E8=BE=B0?= Date: Fri, 19 Jan 2024 18:03:43 +0800 Subject: [PATCH] docs(tree): fix missing event parameters in tree component (#2916) --- packages/web-vue/components/tree/README.en-US.md | 2 +- packages/web-vue/components/tree/README.zh-CN.md | 2 +- packages/web-vue/components/tree/tree.vue | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/web-vue/components/tree/README.en-US.md b/packages/web-vue/components/tree/README.en-US.md index 4e981c3f2..03c4e5b40 100644 --- a/packages/web-vue/components/tree/README.en-US.md +++ b/packages/web-vue/components/tree/README.en-US.md @@ -82,7 +82,7 @@ description: For content with many levels, such as folders, catalogs, and organi |select|Triggered when the tree node is clicked|selectedKeys: `Array`
data: `{ selected?: boolean; selectedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`| |check|Triggered when the tree node checkbox is clicked. `halfCheckedKeys` and `halfCheckedNodes` support from `2.19.0`.|checkedKeys: `Array`
data: `{ checked?: boolean; checkedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; halfCheckedKeys: (string \| number)[]; halfCheckedNodes: TreeNodeData[]; }`| |expand|Expand/close|expandKeys: `Array`
data: `{ expanded?: boolean; expandNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`| -|drag-start|Node starts dragging|-| +|drag-start|Node starts dragging|ev: `DragEvent`
node: `TreeNodeData`| |drag-end|Node end drag|ev: `DragEvent`
node: `TreeNodeData`| |drag-over|The node is dragged to the releasable target|ev: `DragEvent`
node: `TreeNodeData`| |drag-leave|Node leaves to release the target|ev: `DragEvent`
node: `TreeNodeData`| diff --git a/packages/web-vue/components/tree/README.zh-CN.md b/packages/web-vue/components/tree/README.zh-CN.md index 8de882b8c..f08db8fce 100644 --- a/packages/web-vue/components/tree/README.zh-CN.md +++ b/packages/web-vue/components/tree/README.zh-CN.md @@ -80,7 +80,7 @@ description: 对于文件夹、分类目录、组织架构等层级较多的内 |select|点击树节点时触发|selectedKeys: `Array`
data: `{ selected?: boolean; selectedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`| |check|点击树节点复选框时触发。`halfCheckedKeys` 和 `halfCheckedNodes` 从 `2.19.0` 开始支持。|checkedKeys: `Array`
data: `{ checked?: boolean; checkedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; halfCheckedKeys: (string \| number)[]; halfCheckedNodes: TreeNodeData[]; }`| |expand|展开/关闭|expandKeys: `Array`
data: `{ expanded?: boolean; expandNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`| -|drag-start|节点开始拖拽|-| +|drag-start|节点开始拖拽|ev: `DragEvent`
node: `TreeNodeData`| |drag-end|节点结束拖拽|ev: `DragEvent`
node: `TreeNodeData`| |drag-over|节点被拖拽至可释放目标|ev: `DragEvent`
node: `TreeNodeData`| |drag-leave|节点离开可释放目标|ev: `DragEvent`
node: `TreeNodeData`| diff --git a/packages/web-vue/components/tree/tree.vue b/packages/web-vue/components/tree/tree.vue index 0554abfd4..e3d4ec7ed 100644 --- a/packages/web-vue/components/tree/tree.vue +++ b/packages/web-vue/components/tree/tree.vue @@ -372,6 +372,8 @@ export default defineComponent({ /** * @zh 节点开始拖拽 * @en Node starts dragging + * @param {DragEvent} ev + * @param {TreeNodeData} node */ 'dragStart': (ev: DragEvent, node: TreeNodeData) => true, /**