Allow for cell actions to be Alpine methods as well

Author: jissereitsma

Component/Grid/GridViewModel.php

@@ -336,12 +336,30 @@ public function getMassActions(): array
         return $massActions;
     }
 
+    /**
+     * @deprecated Use getEditAction() instead
+     */
     public function getRowAction(DataObject $item): CellAction
+    {
+        return $this->getEditAction($item);
+    }
+
+    public function getEditAction(DataObject $item): CellAction
     {
         // @todo: Retrieve ID from primary key
         $editUrl = $this->getEditUrl(['id' => $item->getId()]);
 
-        return $this->cellActionFactory->create($editUrl, 'Edit');
+        return $this->cellActionFactory->create($this->getEditLabel(), $editUrl);
+    }
+
+    private function getEditLabel(): string
+    {
+        $editLabel = $this->getBlock()->getEditLabel();
+        if (!empty($editLabel)) {
+            return $editLabel;
+        }
+
+        return 'Edit';
     }
 
     /**
@@ -403,19 +421,33 @@ private function getGridFilterStateValues(): array
         return $values;
     }
 
+    /**
+     * @param DataObject $item
+     *
+     * @return CellAction[]
+     */
     public function getCellActions(DataObject $item): array
     {
         if (false === $this->allowActions()) {
             return [];
         }
 
         $cellActions = [];
-        $cellActions[] = $this->getRowAction($item);
+
+        if (false === $this->skipEditAction()) {
+            $cellActions[] = $this->getEditAction($item);
+        }
+
         $cellActions = array_merge($cellActions, $this->getAdditionalActions($item));
 
         return $cellActions;
     }
 
+    private function skipEditAction(): bool
+    {
+        return (bool) $this->getBlock()->getSkipEditAction();
+    }
+
     public function allowActions(): bool
     {
         if ((bool)$this->getBlock()->getData('hide_actions') === true) {
@@ -441,8 +473,18 @@ protected function getAdditionalActions(DataObject $item): array
         if (!empty($actionsFromBlock)) {
             foreach ($actionsFromBlock as $action) {
                 $params = ['id' => $item->getId()];
-                $url = $this->urlFactory->create()->getUrl($action['url'], $params);
-                $actions[] = $this->cellActionFactory->create($url, $action['label']);
+
+                $url = null;
+                if (isset($action['url'])) {
+                    $url = $this->urlFactory->create()->getUrl($action['url'], $params);
+                }
+
+                $jsMethod = null;
+                if (isset($action['jsMethod'])) {
+                    $jsMethod = $action['jsMethod'];
+                }
+
+                $actions[] = $this->cellActionFactory->create($action['label'], $url, $jsMethod);
             }
         }
 

Grid/Cell/CellAction.php

@@ -5,18 +5,34 @@
 class CellAction
 {
     public function __construct(
-        private string $url,
         private string $label,
+        private ?string $url = null,
+        private ?string $jsMethod = null,
     ) {
     }
 
+    public function getLabel(): string
+    {
+        return $this->label;
+    }
+
+    public function hasUrl(): bool
+    {
+        return !empty($this->url);
+    }
+
     public function getUrl(): string
     {
-        return $this->url;
+        return (string)$this->url;
     }
 
-    public function getLabel(): string
+    public function hasJsMethod(): bool
     {
-        return $this->label;
+        return !empty($this->jsMethod);
+    }
+
+    public function getJsMethod(): ?string
+    {
+        return (string)$this->jsMethod;
     }
 }

Grid/Cell/CellActionFactory.php

@@ -11,11 +11,12 @@ public function __construct(
     ) {
     }
 
-    public function create(string $url, string $label): CellAction
+    public function create(string $label, ?string $url = null, ?string $jsMethod = null): CellAction
     {
         return $this->objectManager->create(CellAction::class, [
-            'url' => $url,
             'label' => $label,
+            'url' => $url,
+            'jsMethod' => $jsMethod,
         ]);
     }
 }

view/adminhtml/templates/grid/table.phtml

@@ -132,9 +132,16 @@ $state = $viewModel->getState();
                             <ul>
                                 <?php foreach ($cellActions as $cellAction): ?>
                                     <li>
+                                        <?php if ($cellAction->hasUrl()): ?>
                                         <a href="<?= /* @noEscape */ $cellAction->getUrl() ?>"><?= $escaper->escapeHtml(
                                                 $cellAction->getLabel()
                                             ) ?></a>
+                                        <?php endif; ?>
+                                        <?php if ($cellAction->hasJsMethod()): ?>
+                                            <a @click="<?= /* @noEscape */ $cellAction->getJsMethod() ?>"><?= $escaper->escapeHtml(
+                                                    $cellAction->getLabel()
+                                                ) ?></a>
+                                        <?php endif; ?>
                                     </li>
                                 <?php endforeach; ?>
                             </ul>