docs(tree): fix missing event parameters in tree component

arco-design · Jan 11, 2024 · 02f28cf · 02f28cf
1 parent 3b7a171
commit 02f28cf
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git 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<string \| number>`<br>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<string \| number>`<br>data: `{ checked?: boolean; checkedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; halfCheckedKeys: (string \| number)[]; halfCheckedNodes: TreeNodeData[]; }`|
 |expand|Expand/close|expandKeys: `Array<string \| number>`<br>data: `{ expanded?: boolean; expandNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`|
-|drag-start|Node starts dragging|-|
+|drag-start|Node starts dragging|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-end|Node end drag|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-over|The node is dragged to the releasable target|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-leave|Node leaves to release the target|ev: `DragEvent`<br>node: `TreeNodeData`|

diff --git 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<string \| number>`<br>data: `{ selected?: boolean; selectedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`|
 |check|点击树节点复选框时触发。`halfCheckedKeys` 和 `halfCheckedNodes` 从 `2.19.0` 开始支持。|checkedKeys: `Array<string \| number>`<br>data: `{ checked?: boolean; checkedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; halfCheckedKeys: (string \| number)[]; halfCheckedNodes: TreeNodeData[]; }`|
 |expand|展开/关闭|expandKeys: `Array<string \| number>`<br>data: `{ expanded?: boolean; expandNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }`|
-|drag-start|节点开始拖拽|-|
+|drag-start|节点开始拖拽|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-end|节点结束拖拽|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-over|节点被拖拽至可释放目标|ev: `DragEvent`<br>node: `TreeNodeData`|
 |drag-leave|节点离开可释放目标|ev: `DragEvent`<br>node: `TreeNodeData`|

diff --git 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,
     /**