class OpenOffCanvasDialogCommand in Drupal 9
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Ajax/OpenOffCanvasDialogCommand.php \Drupal\Core\Ajax\OpenOffCanvasDialogCommand
Defines an AJAX command to open content in a dialog in an off-canvas tray.
Hierarchy
- class \Drupal\Core\Ajax\OpenDialogCommand implements CommandInterface, CommandWithAttachedAssetsInterface uses CommandWithAttachedAssetsTrait
- class \Drupal\Core\Ajax\OpenOffCanvasDialogCommand
Expanded class hierarchy of OpenOffCanvasDialogCommand
Related topics
2 files declare their use of OpenOffCanvasDialogCommand
- OffCanvasRenderer.php in core/
lib/ Drupal/ Core/ Render/ MainContent/ OffCanvasRenderer.php - OpenOffCanvasDialogCommandTest.php in core/
tests/ Drupal/ Tests/ Core/ Ajax/ OpenOffCanvasDialogCommandTest.php
File
- core/
lib/ Drupal/ Core/ Ajax/ OpenOffCanvasDialogCommand.php, line 10
Namespace
Drupal\Core\AjaxView source
class OpenOffCanvasDialogCommand extends OpenDialogCommand {
/**
* The dialog width to use if none is provided.
*/
const DEFAULT_DIALOG_WIDTH = 300;
/**
* Constructs an OpenOffCanvasDialogCommand object.
*
* The off-canvas dialog differs from the normal modal provided by
* OpenDialogCommand in that an off-canvas has built in positioning and
* behaviors. Drupal provides a built-in off-canvas dialog for this purpose,
* so the selector is hard-coded in the call to the parent constructor.
*
* @param string $title
* The title of the dialog.
* @param string|array $content
* The content that will be placed in the dialog, either a render array
* or an HTML string.
* @param array $dialog_options
* (optional) Settings to be passed to the dialog implementation. Any
* jQuery UI option can be used. See http://api.jqueryui.com/dialog.
* @param array|null $settings
* (optional) Custom settings that will be passed to the Drupal behaviors
* on the content of the dialog. If left empty, the settings will be
* populated automatically from the current request.
* @param string $position
* (optional) The position to render the off-canvas dialog.
*/
public function __construct($title, $content, array $dialog_options = [], $settings = NULL, $position = 'side') {
parent::__construct('#drupal-off-canvas', $title, $content, $dialog_options, $settings);
$this->dialogOptions['modal'] = FALSE;
$this->dialogOptions['autoResize'] = FALSE;
$this->dialogOptions['resizable'] = 'w';
$this->dialogOptions['draggable'] = FALSE;
$this->dialogOptions['drupalAutoButtons'] = FALSE;
$this->dialogOptions['drupalOffCanvasPosition'] = $position;
// @todo drupal.ajax.js does not respect drupalAutoButtons properly, pass an
// empty set of buttons until https://www.drupal.org/node/2793343 is in.
$this->dialogOptions['buttons'] = [];
if (empty($dialog_options['dialogClass'])) {
$this->dialogOptions['dialogClass'] = "ui-dialog-off-canvas ui-dialog-position-{$position}";
}
// If no width option is provided then use the default width to avoid the
// dialog staying at the width of the previous instance when opened
// more than once, with different widths, on a single page.
if (!isset($this->dialogOptions['width'])) {
$this->dialogOptions['width'] = static::DEFAULT_DIALOG_WIDTH;
}
}
/**
* {@inheritdoc}
*/
public function render() {
$build = parent::render();
$build['effect'] = 'fade';
$build['speed'] = 1000;
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommandWithAttachedAssetsTrait:: |
protected | property | The attached assets for this Ajax command. | |
CommandWithAttachedAssetsTrait:: |
public | function | Gets the attached assets. | |
CommandWithAttachedAssetsTrait:: |
protected | function | Processes the content for output. | |
OpenDialogCommand:: |
protected | property | The content for the dialog. | |
OpenDialogCommand:: |
protected | property | Stores dialog-specific options passed directly to jQuery UI dialogs. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog. | |
OpenDialogCommand:: |
protected | property | The selector of the dialog. | |
OpenDialogCommand:: |
protected | property | Custom settings that will be passed to the Drupal behaviors on the content of the dialog. | |
OpenDialogCommand:: |
protected | property | The title of the dialog. | |
OpenDialogCommand:: |
public | function | Returns the dialog options. | |
OpenDialogCommand:: |
public | function | Sets a single dialog option value. | |
OpenDialogCommand:: |
public | function | Sets the dialog options array. | |
OpenDialogCommand:: |
public | function | Sets the dialog title (an alias of setDialogOptions). | |
OpenOffCanvasDialogCommand:: |
constant | The dialog width to use if none is provided. | ||
OpenOffCanvasDialogCommand:: |
public | function |
Implements \Drupal\Core\Ajax\CommandInterface:render(). Overrides OpenDialogCommand:: |
|
OpenOffCanvasDialogCommand:: |
public | function |
Constructs an OpenOffCanvasDialogCommand object. Overrides OpenDialogCommand:: |