Feature/Panel Action Executor

demos/collection/crud.php

@@ -81,7 +81,7 @@ public function addFormTo(\Atk4\Ui\View $view): \Atk4\Ui\Form
 
         if ($this->action->getEntity()->get(File::hinting()->fieldName()->is_folder)) {
             \Atk4\Ui\Grid::addTo($right, ['menu' => false, 'ipp' => 5])
-                ->setModel(File::assertInstanceOf($this->action->getModel())->SubFolder);
+                ->setModel(File::assertInstanceOf($this->getAction()->getModel())->SubFolder);
         } else {
             \Atk4\Ui\Message::addTo($right, ['Not a folder', 'warning']);
         }

demos/data-action/action-setup.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Ui\Demos;
+
+// Demo for Model action
+
+use Atk4\Ui\App;
+use Atk4\Ui\Message;
+
+/** @var App $app */
+$country = new CountryLock($app->db);
+$entity = $country->tryLoadAny();
+$countryId = $entity->getId();
+
+// Model actions for this file are setup in DemoActionUtil.
+DemoActionsUtil::setupDemoActions($country);
+
+\Atk4\Ui\Header::addTo($app, ['Assign Model action to button event', 'subHeader' => 'Execute model action on this country record by clicking on the appropriate button on the right.']);
+
+$msg = Message::addTo($app, ['Notes', 'type' => 'info']);
+$msg->text->addParagraph('When passing an action to a button event, Ui will determine what executor is required base on the action properties.');
+$msg->text->addParagraph('If action require arguments, fields and/or preview, then a ModalExecutor will be use.');
+
+\Atk4\Ui\View::addTo($app, ['ui' => 'ui clearing divider']);
+
+$gl = \Atk4\Ui\GridLayout::addTo($app, ['rows' => 1, 'columns' => 2]);
+$c = \Atk4\Ui\Card::addTo($gl, ['useLabel' => true], ['r1c1']);
+$c->addContent(new \Atk4\Ui\Header(['Using country: ']));
+$c->setModel($entity, [$country->fieldName()->iso, $country->fieldName()->iso3, $country->fieldName()->phonecode]);
+
+$buttons = \Atk4\Ui\View::addTo($gl, ['ui' => 'vertical basic buttons'], ['r1c2']);
+
+// Create a button for every action in Country model.
+foreach ($country->getUserActions() as $action) {
+    $b = \Atk4\Ui\Button::addTo($buttons, [$action->getCaption()]);
+    // Assign action to button using current model id as url arguments.
+    $b->on('click', $action, ['args' => ['id' => $countryId]]);
+}

demos/data-action/jsactions-panel.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Ui\Demos;
+
+use Atk4\Ui\UserAction\PanelExecutor;
+
+/** @var \Atk4\Ui\App $app */
+require_once __DIR__ . '/../init-app.php';
+
+$factory = $app->getExecutorFactory();
+$factory->registerTypeExecutor($factory::STEP_EXECUTOR, [PanelExecutor::class]);
+
+require_once 'action-setup.php';

demos/init-app.php

@@ -120,6 +120,7 @@
     $layout->addMenuItem(['Executor Examples'], [$path . 'actions'], $menu);
     $layout->addMenuItem(['Assign action to event'], [$path . 'jsactions'], $menu);
     $layout->addMenuItem(['Assign action to button (Modal)'], [$path . 'jsactions2'], $menu);
+    $layout->addMenuItem(['Assign action to button (Panel)'], [$path . 'jsactions-panel'], $menu);
     $layout->addMenuItem(['Assign action to button (V. Page)'], [$path . 'jsactions-vp'], $menu);
     $layout->addMenuItem(['Execute from Grid'], [$path . 'jsactionsgrid'], $menu);
     $layout->addMenuItem(['Execute from Crud'], [$path . 'jsactionscrud'], $menu);

demos/layout/layout-panel.php

@@ -4,70 +4,76 @@
 
 namespace Atk4\Ui\Demos;
 
+use Atk4\Ui\Header;
+use Atk4\Ui\Message;
+use Atk4\Ui\Panel\Right;
+use Atk4\Ui\View;
+
 /** @var \Atk4\Ui\App $app */
 require_once __DIR__ . '/../init-app.php';
 
 $country = new CountryLock($app->db);
 DemoActionsUtil::setupDemoActions($country);
 
-\Atk4\Ui\Header::addTo($app, ['Right Panel', 'subHeader' => 'Content on the fly!']);
+Header::addTo($app, ['Right Panel', 'subHeader' => 'Content on the fly!']);
 
 // PANEL
 
-\Atk4\Ui\Header::addTo($app, ['Static', 'size' => 4, 'subHeader' => 'Panel may have static content only.']);
-$panel = $app->layout->addRightPanel(new \Atk4\Ui\Panel\Right(['dynamic' => false]));
-\Atk4\Ui\Message::addTo($panel, ['This panel contains only static content.']);
+Header::addTo($app, ['Static', 'size' => 4, 'subHeader' => 'Panel may have static content only.']);
+$panel = Right::addTo($app, ['dynamic' => []]);
+Message::addTo($panel, ['This panel contains only static content.']);
 $btn = \Atk4\Ui\Button::addTo($app, ['Open Static']);
 $btn->on('click', $panel->jsOpen());
-\Atk4\Ui\View::addTo($app, ['ui' => 'divider']);
+View::addTo($app, ['ui' => 'divider']);
 
 // PANEL_1
 
-\Atk4\Ui\Header::addTo($app, ['Dynamic', 'size' => 4, 'subHeader' => 'Panel can load content dynamically']);
-$panel1 = $app->layout->addRightPanel(new \Atk4\Ui\Panel\Right());
-\Atk4\Ui\Message::addTo($panel1, ['This panel will load content dynamically below according to button select on the right.']);
+Header::addTo($app, ['Dynamic', 'size' => 4, 'subHeader' => 'Panel can load content dynamically']);
+$panel1 = Right::addTo($app);
+
+Message::addTo($panel1, ['This panel will load content dynamically below according to button select on the right.']);
 $btn = \Atk4\Ui\Button::addTo($app, ['Button 1']);
 $btn->js(true)->data('btn', '1');
-$btn->on('click', $panel1->jsOpen(['btn'], 'orange'));
+$btn->on('click', $panel1->jsOpen([], ['btn'], 'orange'));
 
 $btn = \Atk4\Ui\Button::addTo($app, ['Button 2']);
 $btn->js(true)->data('btn', '2');
-$btn->on('click', $panel1->jsOpen(['btn'], 'orange'));
+$btn->on('click', $panel1->jsOpen([], ['btn'], 'orange'));
 
-$view = \Atk4\Ui\View::addTo($app, ['ui' => 'segment']);
+$view = View::addTo($app, ['ui' => 'segment']);
 $text = \Atk4\Ui\Text::addTo($view);
 $text->set($_GET['txt'] ?? 'Not Complete');
 
 $panel1->onOpen(function ($p) use ($view) {
-    $panel = \Atk4\Ui\View::addTo($p, ['ui' => 'basic segment']);
+    $panel = View::addTo($p, ['ui' => 'basic segment']);
     $buttonNumber = $panel->stickyGet('btn');
 
     $panelText = 'You loaded panel content using button #' . $buttonNumber;
-    \Atk4\Ui\Message::addTo($panel, ['Panel 1', 'text' => $panelText]);
+    Message::addTo($panel, ['Panel 1', 'text' => $panelText]);
 
     $reloadPanelButton = \Atk4\Ui\Button::addTo($panel, ['Reload Myself']);
     $reloadPanelButton->on('click', new \Atk4\Ui\JsReload($panel));
 
-    \Atk4\Ui\View::addTo($panel, ['ui' => 'divider']);
+    View::addTo($panel, ['ui' => 'divider']);
     $panelButton = \Atk4\Ui\Button::addTo($panel, ['Complete']);
     $panelButton->on('click', [
         $p->getOwner()->jsClose(),
         new \Atk4\Ui\JsReload($view, ['txt' => 'Complete using button #' . $buttonNumber]),
     ]);
 });
 
-\Atk4\Ui\View::addTo($app, ['ui' => 'divider']);
+View::addTo($app, ['ui' => 'divider']);
 
 // PANEL_2
 
-\Atk4\Ui\Header::addTo($app, ['Closing option', 'size' => 4, 'subHeader' => 'Panel can prevent from closing.']);
+Header::addTo($app, ['Closing option', 'size' => 4, 'subHeader' => 'Panel can prevent from closing.']);
 
-$panel2 = $app->layout->addRightPanel(new \Atk4\Ui\Panel\Right(['hasClickAway' => false]));
+$panel2 = Right::addTo($app, ['hasClickAway' => false]);
 $icon = \Atk4\Ui\Icon::addTo($app, ['big cog'])->addStyle('cursor', 'pointer');
 $icon->on('click', $panel2->jsOpen());
 $panel2->addConfirmation('Changes will be lost. Are you sure?');
 
-$msg = \Atk4\Ui\Message::addTo($panel2, ['Prevent close.']);
+$msg = Message::addTo($panel2, ['Prevent close.']);
 
 $txt = \Atk4\Ui\Text::addTo($msg);
 $txt->addParagraph('This panel can only be closed via it\'s close icon at top right.');
@@ -88,28 +94,29 @@
         ];
     });
 });
-\Atk4\Ui\View::addTo($app, ['ui' => 'divider']);
+View::addTo($app, ['ui' => 'divider']);
 
 // PANEL_3
 
 $countryId = $app->stickyGet('id');
-\Atk4\Ui\Header::addTo($app, ['UserAction Friendly', 'size' => 4, 'subHeader' => 'Panel can run model action.']);
-$panel3 = $app->layout->addRightPanel(new \Atk4\Ui\Panel\Right());
-$msg = \Atk4\Ui\Message::addTo($panel3, ['Run Country model action below.']);
+Header::addTo($app, ['UserAction Friendly', 'size' => 4, 'subHeader' => 'Panel can run model action.']);
+
+$panel3 = Right::addTo($app);
+$msg = Message::addTo($panel3, ['Run Country model action below.']);
 
-$deck = \Atk4\Ui\View::addTo($app, ['ui' => 'cards']);
+$deck = View::addTo($app, ['ui' => 'cards']);
 $country->setLimit(3);
 
 foreach ($country as $ct) {
     $c = \Atk4\Ui\Card::addTo($deck, ['useLabel' => true])->addStyle('cursor', 'pointer');
     $c->setModel($ct);
-    $c->on('click', $panel3->jsOpen(['id'], 'orange'));
+    $c->on('click', $panel3->jsOpen([], ['id'], 'orange'));
 }
 
 $panel3->onOpen(function ($p) use ($country, $countryId) {
-    $seg = \Atk4\Ui\View::addTo($p, ['ui' => 'basic segment center aligned']);
-    \Atk4\Ui\Header::addTo($seg, [$country->load($countryId)->getTitle()]);
-    $buttons = \Atk4\Ui\View::addTo($seg, ['ui' => 'vertical basic buttons']);
+    $seg = View::addTo($p, ['ui' => 'basic segment center aligned']);
+    Header::addTo($seg, [$country->load($countryId)->getTitle()]);
+    $buttons = View::addTo($seg, ['ui' => 'vertical basic buttons']);
     foreach ($country->getUserActions() as $action) {
         $button = \Atk4\Ui\Button::addTo($buttons, [$action->getCaption()]);
         $button->on('click', $action, ['args' => ['id' => $countryId]]);

js/Release.md

@@ -1,5 +1,11 @@
 ## Release note
 
+### version 1.21.0 (2021-07-15)
+
+- Implement Panel as portal view in order to properly manage them on reload.
+    - Changes in api service.
+- Add remove panel to panel service. Will now remove panel from list of panels but also remove them from dom, like Modal.
+
 ### version 1.20.0 (2021-07-14)
 
 - Add redirect utils method.