Add new emitter in Tree component: onNodeDoubleClick (#17284)

Co-authored-by: Ewan Humbert <[email protected]>
primefaces · Jan 15, 2025 · 3bad663 · 3bad663
1 parent d8200ce
commit 3bad663
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 0 deletions.
diff --git a/apps/showcase/doc/apidoc/index.json b/apps/showcase/doc/apidoc/index.json
@@ -34576,6 +34576,16 @@
                             ],
                             "description": "Callback to invoke when a node is selected with right click."
                         },
+                        {
+                            "name": "onNodeDoubleClick",
+                            "parameters": [
+                                {
+                                    "name": "event",
+                                    "type": "TreeNodeDoubleClickEvent"
+                                }
+                            ],
+                            "description": "Callback to invoke when a node is double clicked."
+                        },
                         {
                             "name": "onNodeDrop",
                             "parameters": [
@@ -34888,6 +34898,26 @@
                             }
                         ]
                     },
+                    {
+                        "name": "TreeNodeDoubleClickEvent",
+                        "description": "Custom node double click event.",
+                        "props": [
+                            {
+                                "name": "originalEvent",
+                                "optional": false,
+                                "readonly": false,
+                                "type": "Event",
+                                "description": "Browser event"
+                            },
+                            {
+                                "name": "node",
+                                "optional": false,
+                                "readonly": false,
+                                "type": "TreeNode<any>",
+                                "description": "Node instance."
+                            }
+                        ]
+                    },
                     {
                         "name": "TreeNodeDropEvent",
                         "description": "Custom node drop event.",

diff --git a/packages/primeng/src/tree/tree.interface.ts b/packages/primeng/src/tree/tree.interface.ts
@@ -45,6 +45,13 @@ export interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {}
  * @group Events
  */
 export interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {}
+/**
+ * Custom node double click event.
+ * @see {@link Tree.onNodeDoubleClick}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+export interface TreeNodeDoubleClickEvent extends TreeNodeSelectEvent {}
 /**
  * Custom node drop event.
  * @see {@link Tree.onNodeDrop}

diff --git a/packages/primeng/src/tree/tree.ts b/packages/primeng/src/tree/tree.ts
@@ -43,6 +43,7 @@ import {
     TreeLazyLoadEvent,
     TreeNodeCollapseEvent,
     TreeNodeContextMenuSelectEvent,
+    TreeNodeDoubleClickEvent,
     TreeNodeDropEvent,
     TreeNodeExpandEvent,
     TreeNodeSelectEvent,
@@ -88,6 +89,7 @@ import {
                     [style.paddingLeft]="level * indentation + 'rem'"
                     (click)="onNodeClick($event)"
                     (contextmenu)="onNodeRightClick($event)"
+                    (dblclick)="onNodeDblClick($event)"
                     (touchend)="onNodeTouchEnd()"
                     (drop)="onDropNode($event)"
                     (dragover)="onDropNodeDragOver($event)"
@@ -299,6 +301,10 @@ export class UITreeNode extends BaseComponent implements OnInit {
         this.tree.onNodeRightClick(event, <TreeNode>this.node);
     }
 
+    onNodeDblClick(event: MouseEvent) {
+        this.tree.onNodeDblClick(event, <TreeNode>this.node);
+    }
+
     isSelected() {
         return this.tree.isSelected(<TreeNode>this.node);
     }
@@ -1033,6 +1039,12 @@ export class Tree extends BaseComponent implements OnInit, AfterContentInit, OnC
      * @group Emits
      */
     @Output() onNodeContextMenuSelect: EventEmitter<TreeNodeContextMenuSelectEvent> = new EventEmitter<TreeNodeContextMenuSelectEvent>();
+    /**
+     * Callback to invoke when a node is double clicked.
+     * @param {TreeNodeDoubleClickEvent} event - Node double click event.
+     * @group Emits
+     */
+    @Output() onNodeDoubleClick: EventEmitter<TreeNodeDoubleClickEvent> = new EventEmitter<TreeNodeDoubleClickEvent>();
     /**
      * Callback to invoke when a node is dropped.
      * @param {TreeNodeDropEvent} event - Node drop event.
@@ -1414,6 +1426,10 @@ export class Tree extends BaseComponent implements OnInit, AfterContentInit, OnC
         }
     }
 
+    onNodeDblClick(event: MouseEvent, node: TreeNode<any>) {
+        this.onNodeDoubleClick.emit({ originalEvent: event, node: node });
+    }
+
     findIndexInSelection(node: TreeNode) {
         let index: number = -1;
         if (this.selectionMode && this.selection) {