Class Atk4\Ui\Modal

`extends`	`View`

This class add modal dialog to a page.

Modal are added to the layout but their content is hidden by default. $modal->jsShow() is the triggered needed to actually display the modal.

Modal can be use as a regular view, simply by adding other view to it. Message::addTo($modal, ['title' => 'Welcome to Agile Toolkit'])->text('Your text here');

Modal can add content dynamically via CallbackLater. $modal->set(function (View $p) { Form::addTo($p); });

Modal can use Fomantic-UI predefine method onApprove or onDeny by passing a jsAction to Modal::addDenyAction or Modal::addApproveAction method. It will not close until the jsAction return true. $modal->addDenyAction('No', new JsExpression('function () { window.alert('Cannot do that.'); return false; }')); $modal->addApproveAction('Yes', new JsExpression('function () { window.alert('You are good to go!'); }'));

You may also prevent modal from closing via the esc or dimmed area click using $modal->notClosable().

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\Modal
    - Atk4\Ui\UserAction\ConfirmationExecutor implements JsExecutorInterface uses CommonExecutorTrait, HookTrait
    - Atk4\Ui\UserAction\ModalExecutor implements JsExecutorInterface uses CommonExecutorTrait, HookTrait, StepExecutorTrait

Located at ui/src/Modal.php

Methods


					
	public

set(Closure(View): void $fx = null)

Set callback function for this modal.

Overrides

Atk4\Ui\View::set()


					
	public

enableCallback(): void

Add View to be loaded in this modal and attach CallbackLater to it. The cbView only will be loaded dynamically within…

Add View to be loaded in this modal and attach CallbackLater to it. The cbView only will be loaded dynamically within modal div.atk-content.


					
	public

addContentCss(string|array $class): void

Add CSS classes to "content" div.


					
	public

jsShow(array $args = []): JsChain

Show modal on page.

Example: $button->on('click', $modal->jsShow());


					
	public

jsHide(): JsChain

Hide modal from page.


					
	public

setOption(string $option, mixed $value): $this

Set modal option.


					
	public

addScrolling(): $this

Add scrolling capability to modal.


					
	public

addDenyAction(string $label, JsExpressionable $jsAction): $this

Add a deny action to modal.

Parameters

$jsAction

will run when deny is click


					
	public

addApproveAction(string $label, JsExpressionable $jsAction): $this

Add an approve action button to modal.

Parameters

$jsAction

will run when deny is click


					
	public

addButtonAction(View $button): $this

Add an action button to modal.


					
	public

notClosable(): $this

Make this modal not closable via close icon, esc key or via the dimmer area.


					
	protected

renderView(): void

View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic…

View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic that integrates with Fomantic-UI.

Overrides

Atk4\Ui\View::renderView()

Methods inherited from Atk4\Ui\View
__construct(), setModel(), setSource(), setMissingProperty(), setElement(), link(), init(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\View

__construct(), setModel(), setSource(), setMissingProperty(), setElement(), link(), init(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Properties
`public`		`$ui = 'modal'`	#
`public`		`$defaultTemplate = 'modal.html'`	#
`public`	`string\|null`	`$title` Set null for no title Set null for no title	#
`public`	`string`	`$loadingLabel = 'Loading...'`	#
`public`	`string`	`$headerCss = 'header'`	#
`public`	`(Closure(View): void)\|null`	`$fx`	#
`public`	`CallbackLater\|null`	`$cb`	#
`public`	`View\|null`	`$cbView`	#
`public`	`array`	`$args = []`	#
`public`	`array`	`$options = []`	#
`public`	`string`	`$type = 'json'` Currently only "json" response type is supported. Currently only "json" response type is supported.	#
`public`	`array`	`$contentCss = ['img', 'content', 'atk-dialog-content']` Add ability to add CSS classes to "content" div. Add ability to add CSS classes to "content" div.	#
`public`	`bool`	`$showActions = false`	#

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $class, $style, $attr, $template, $content, $element, $executorFactory, $stickyArgs`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\NameTrait
`$name`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Traits

Exceptions

Class Atk4\Ui\Modal

Overrides

Parameters

Parameters

Overrides