UI/DataTable: Actions may open Prompts

components/ILIAS/UI/resources/js/Table/src/datatable.class.js

@@ -64,6 +64,11 @@ export default class DataTable {
    */
   #responseContent;
 
+  /**
+   * @type {HTMLDivElement}
+   */
+  #prompt;
+
   /**
    * @type {HTMLTableElement}
    */
@@ -93,6 +98,7 @@ export default class DataTable {
     this.#modalResponseArea = this.#component.getElementsByClassName('c-table-data__async_modal_container').item(0);
     this.#responseContainer = this.#component.getElementsByClassName('c-table-data__async_message').item(0);
     this.#responseContent = this.#responseContainer.getElementsByClassName('c-table-data__async_messageresponse').item(0);
+    this.#prompt = this.#component.querySelector('.c-table-data__dialog_container .il-prompt');
 
     this.#jquery = jquery;
     this.#signalConstants = {
@@ -106,7 +112,7 @@ export default class DataTable {
 
   /**
    * @param {string} actionId
-   * @param {bool} async
+   * @param {string} async
    * @param {URLBuilder} urlBuilder
    * @param {Map} urlTokens
    * @return {void}
@@ -210,8 +216,10 @@ export default class DataTable {
     action.urlBuilder.writeParameter(token, rowIds);
     const target = decodeURI(action.urlBuilder.getUrl().toString());
 
-    if (!action.async) {
+    if (action.async === 'none') {
       window.location.href = target;
+    } else if (action.async === 'prompt') {
+      il.UI.prompt.get(this.#prompt.id).show(target);
     } else {
       this.asyncAction(target);
     }

components/ILIAS/UI/src/Component/Prompt/Factory.php

@@ -51,7 +51,7 @@ interface Factory
      * ---
      * @return \ILIAS\UI\Component\Prompt\Prompt
      */
-    public function standard(URI $async_url): Prompt;
+    public function standard(URI $async_url = null): Prompt;
 
     /**
      * ---

components/ILIAS/UI/src/Component/Table/Action/Action.php

@@ -25,5 +25,13 @@
 
 interface Action extends \ILIAS\UI\Component\Component
 {
+    /**
+     * call the Action asynchronously
+     */
     public function withAsync(bool $async = true): self;
+
+    /**
+     * open a Prompt with an async call to the Actions's target
+     */
+    public function withPrompt(bool $prompt = true): self;
 }

components/ILIAS/UI/src/Implementation/Component/Prompt/Factory.php

@@ -31,7 +31,7 @@ public function __construct(
     ) {
     }
 
-    public function standard(URI $async_url): I\Prompt
+    public function standard(URI $async_url = null): I\Prompt
     {
         return new Standard($this->signal_generator, $async_url);
     }

components/ILIAS/UI/src/Implementation/Component/Prompt/Prompt.php

@@ -25,7 +25,6 @@
 use ILIAS\UI\Implementation\Component\ComponentHelper;
 use ILIAS\UI\Implementation\Component\JavaScriptBindable;
 use ILIAS\UI\Implementation\Component\SignalGenerator;
-
 use ILIAS\Data\URI;
 
 /**
@@ -41,13 +40,13 @@ abstract class Prompt implements I\Prompt
 
     public function __construct(
         SignalGenerator $signal_generator,
-        protected URI $async_url
+        protected ?URI $async_url
     ) {
         $this->show_signal = $signal_generator->create();
         $this->close_signal = $signal_generator->create();
     }
 
-    public function getAsyncUrl(): URI
+    public function getAsyncUrl(): ?URI
     {
         return $this->async_url;
     }
@@ -56,7 +55,7 @@ public function getShowSignal(?URI $uri = null): Signal
     {
         $target = $uri ?? $this->async_url;
         $signal = clone $this->show_signal;
-        $signal->addOption('url', $target->__toString());
+        $signal->addOption('url', $target ? $target->__toString() : '#');
         return $signal;
     }
 

components/ILIAS/UI/src/Implementation/Component/Prompt/Renderer.php

@@ -54,7 +54,7 @@ protected function renderPrompt(Component\Prompt\Prompt $component, RendererInte
         $tpl = $this->getTemplate('tpl.prompt.html', true, true);
         $show_signal = $component->getShowSignal();
         $close_signal = $component->getCloseSignal();
-        $url = $component->getAsyncUrl()->__toString();
+        $url = $component->getAsyncUrl()?->__toString();
         $component = $component->withAdditionalOnLoadCode(
             fn($id) => "
                 il.UI.prompt.init('$id');

components/ILIAS/UI/src/Implementation/Component/Table/Action/Action.php

@@ -40,6 +40,7 @@ abstract class Action implements I\Action
 
     protected Signal|URI $target;
     protected bool $async = false;
+    protected bool $prompt = false;
 
     public function __construct(
         protected string $label,
@@ -68,6 +69,9 @@ public function withSignalTarget(Signal $target): self
 
     public function withAsync(bool $async = true): self
     {
+        if ($this->isPrompt()) {
+            throw new \LogicException("Action is configured to use Prompt already. Use either Async or Prompt", 1);
+        }
         $clone = clone $this;
         $clone->async = $async;
         return $clone;
@@ -78,6 +82,21 @@ public function isAsync(): bool
         return $this->async;
     }
 
+    public function withPrompt(bool $prompt = true): self
+    {
+        if ($this->isAsync()) {
+            throw new \LogicException("Action is async already. Use either Async or Prompt", 1);
+        }
+        $clone = clone $this;
+        $clone->prompt = $prompt;
+        return $clone;
+    }
+
+    public function isPrompt(): bool
+    {
+        return $this->prompt;
+    }
+
     public function withRowId(string $row_id): self
     {
         $clone = clone $this;

components/ILIAS/UI/src/Implementation/Component/Table/Renderer.php

@@ -223,6 +223,10 @@ public function renderDataTable(Component\Table\Data $component, RendererInterfa
         $tpl->setVariable('COL_COUNT', (string) $component->getColumnCount());
         $tpl->setVariable('VIEW_CONTROLS', $default_renderer->render($view_controls));
 
+        $tpl->setVariable('DIALOG', $default_renderer->render(
+            $this->getUIFactory()->prompt()->standard()
+        ));
+
         $sortation_signal = null;
         // if the generator is empty, and thus invalid, we render an empty row.
         if (!$rows->valid()) {
@@ -369,7 +373,7 @@ protected function registerActions(Component\Table\Table $component): Component\
         $actions = [];
         foreach ($component->getAllActions() as $action_id => $action) {
             $component = $component->withAdditionalOnLoadCode($this->getActionRegistration((string) $action_id, $action));
-            if ($action->isAsync()) {
+            if ($action->isAsync() || $action->isPrompt()) {
                 $signal = clone $component->getAsyncActionSignal();
                 $signal->addOption(Action::OPT_ACTIONID, $action_id);
                 $action = $action->withSignalTarget($signal);
@@ -503,13 +507,19 @@ protected function getActionRegistration(
         string $action_id,
         Action $action
     ): \Closure {
-        $async = $action->isAsync() ? 'true' : 'false';
+        $async = 'none';
+        if ($action->isAsync()) {
+            $async = 'async';
+        }
+        if ($action->isPrompt()) {
+            $async = 'prompt';
+        }
         $url_builder_js = $action->getURLBuilderJS();
         $tokens_js = $action->getURLBuilderTokensJS();
 
         return static function ($id) use ($action_id, $async, $url_builder_js, $tokens_js): string {
             return "
-                il.UI.table.data.get('{$id}').registerAction('{$action_id}', {$async}, {$url_builder_js}, {$tokens_js});
+                il.UI.table.data.get('{$id}').registerAction('{$action_id}', '{$async}', {$url_builder_js}, {$tokens_js});
             ";
         };
     }