From c9e6256e7f2c06da8bfda13700f56f6994e76eab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Norman=20Fei=C3=9F?=
 <127290039+nfpocket@users.noreply.github.com>
Date: Wed, 6 Nov 2024 19:12:51 +0100
Subject: [PATCH] feat(Table): add contextmenu handling to table rows (#2283)

---
 .../examples/TableExampleContextmenu.vue      | 66 +++++++++++++++++++
 docs/content/2.components/table.md            | 16 +++++
 src/runtime/components/data/Table.vue         | 12 +++-
 3 files changed, 93 insertions(+), 1 deletion(-)
 create mode 100644 docs/components/content/examples/TableExampleContextmenu.vue

diff --git a/docs/components/content/examples/TableExampleContextmenu.vue b/docs/components/content/examples/TableExampleContextmenu.vue
new file mode 100644
index 00000000..ac49db3b
--- /dev/null
+++ b/docs/components/content/examples/TableExampleContextmenu.vue
@@ -0,0 +1,66 @@
+<script setup lang="ts">
+const people = [{
+  id: 1,
+  name: 'Lindsay Walton',
+  title: 'Front-end Developer',
+  email: 'lindsay.walton@example.com',
+  role: 'Member'
+}, {
+  id: 2,
+  name: 'Courtney Henry',
+  title: 'Designer',
+  email: 'courtney.henry@example.com',
+  role: 'Admin'
+}, {
+  id: 3,
+  name: 'Tom Cook',
+  title: 'Director of Product',
+  email: 'tom.cook@example.com',
+  role: 'Member'
+}, {
+  id: 4,
+  name: 'Whitney Francis',
+  title: 'Copywriter',
+  email: 'whitney.francis@example.com',
+  role: 'Admin'
+}, {
+  id: 5,
+  name: 'Leonard Krasner',
+  title: 'Senior Designer',
+  email: 'leonard.krasner@example.com',
+  role: 'Owner'
+}]
+
+const virtualElement = ref({ getBoundingClientRect: () => ({}) })
+const contextMenuRow = ref()
+
+function contextmenu(event: MouseEvent, row: any) {
+  // Prevent the default context menu
+  event.preventDefault()
+
+  virtualElement.value.getBoundingClientRect = () => ({
+    width: 0,
+    height: 0,
+    top: event.clientY,
+    left: event.clientX
+  })
+
+  contextMenuRow.value = row
+}
+</script>
+
+<template>
+  <div>
+    <UTable :rows="people" @contextmenu.stop="contextmenu" />
+
+    <UContextMenu
+      :virtual-element="virtualElement"
+      :model-value="!!contextMenuRow"
+      @update:model-value="contextMenuRow = null"
+    >
+      <div class="p-4">
+        {{ contextMenuRow.id }} - {{ contextMenuRow.name }}
+      </div>
+    </UContextMenu>
+  </div>
+</template>
diff --git a/docs/content/2.components/table.md b/docs/content/2.components/table.md
index a3b421fe..8fbe24fe 100644
--- a/docs/content/2.components/table.md
+++ b/docs/content/2.components/table.md
@@ -285,6 +285,22 @@ componentProps:
 ---
 ::
 
+### Contextmenu
+
+Use the `contextmenu` listener on your Table to make the rows righ-clickable. The function will receive the original event as the first argument and the row as the second argument.
+
+You can use this to open a [ContextMenu](/components/context-menu) for that row.
+
+::component-example{class="grid"}
+---
+extraClass: 'overflow-hidden'
+padding: false
+component: 'table-example-contextmenu'
+componentProps:
+  class: 'flex-1 flex-col overflow-hidden'
+---
+::
+
 ### Searchable
 
 You can easily use the [Input](/components/input) component to filter the rows.
diff --git a/src/runtime/components/data/Table.vue b/src/runtime/components/data/Table.vue
index be766500..1fb1e8c9 100644
--- a/src/runtime/components/data/Table.vue
+++ b/src/runtime/components/data/Table.vue
@@ -77,7 +77,7 @@
 
         <template v-else>
           <template v-for="(row, index) in rows" :key="index">
-            <tr :class="[ui.tr.base, isSelected(row) && ui.tr.selected, isExpanded(row) && ui.tr.expanded, $attrs.onSelect && ui.tr.active, row?.class]" @click="() => onSelect(row)">
+            <tr :class="[ui.tr.base, isSelected(row) && ui.tr.selected, isExpanded(row) && ui.tr.expanded, ($attrs.onSelect || $attrs.onContextmenu) && ui.tr.active, row?.class]" @click="() => onSelect(row)" @contextmenu="(event) => onContextmenu(event, row)">
               <td v-if="modelValue" :class="ui.checkbox.padding">
                 <UCheckbox
                   :model-value="isSelected(row)"
@@ -363,6 +363,15 @@ export default defineComponent({
       $attrs.onSelect(row)
     }
 
+    function onContextmenu(event, row) {
+      if (!$attrs.onContextmenu) {
+        return
+      }
+
+      // @ts-ignore
+      $attrs.onContextmenu(event, row)
+    }
+
     function selectAllRows() {
       // Create a new array to ensure reactivity
       const newSelected = [...selected.value]
@@ -451,6 +460,7 @@ export default defineComponent({
       isSelected,
       onSort,
       onSelect,
+      onContextmenu,
       onChange,
       getRowData,
       toggleOpened,