class ToolbarItem
Same name in other branches
- 9 core/modules/toolbar/src/Element/ToolbarItem.php \Drupal\toolbar\Element\ToolbarItem
- 8.9.x core/modules/toolbar/src/Element/ToolbarItem.php \Drupal\toolbar\Element\ToolbarItem
- 11.x core/modules/toolbar/src/Element/ToolbarItem.php \Drupal\toolbar\Element\ToolbarItem
Provides a toolbar item that is wrapped in markup for common styling.
The 'tray' property contains a renderable array.
Attributes
#[RenderElement('toolbar_item')]Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\toolbar\Element\ToolbarItem extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of ToolbarItem
4 string references to 'ToolbarItem'
- CKEditor5::shouldHaveVisiblePluginSettingsForm in core/
modules/ ckeditor5/ src/ Plugin/ Editor/ CKEditor5.php - Determines whether the plugin settings form should be visible.
- CKEditor5PluginManager::isPluginDisabled in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor5PluginManager.php - Checks whether a plugin must be disabled due to unmet conditions.
- ToolbarItemConditionsMetConstraintValidator::validate in core/
modules/ ckeditor5/ src/ Plugin/ Validation/ Constraint/ ToolbarItemConditionsMetConstraintValidator.php - ToolbarItemDependencyConstraint::getRequiredOptions in core/
modules/ ckeditor5/ src/ Plugin/ Validation/ Constraint/ ToolbarItemDependencyConstraint.php
File
-
core/
modules/ toolbar/ src/ Element/ ToolbarItem.php, line 14
Namespace
Drupal\toolbar\ElementView source
class ToolbarItem extends RenderElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#pre_render' => [
[
$class,
'preRenderToolbarItem',
],
],
'tab' => [
'#type' => 'link',
'#title' => '',
'#url' => Url::fromRoute('<front>'),
],
];
}
/**
* Provides markup for associating a tray trigger with a tray element.
*
* A tray is a responsive container that wraps renderable content. Trays
* present content well on small and large screens alike.
*
* @param array $element
* A renderable array.
*
* @return array
* A renderable array.
*/
public static function preRenderToolbarItem($element) {
$id = $element['#id'];
// Provide attributes for a toolbar item.
$attributes = [
'id' => $id,
];
// If tray content is present, markup the tray and its associated trigger.
if (!empty($element['tray'])) {
// Provide attributes necessary for trays.
$attributes += [
'data-toolbar-tray' => $id . '-tray',
'role' => 'button',
'aria-pressed' => 'false',
];
// Merge in module-provided attributes.
$element['tab'] += [
'#attributes' => [],
];
$element['tab']['#attributes'] += $attributes;
$element['tab']['#attributes']['class'][] = 'trigger';
// Provide attributes for the tray theme wrapper.
$attributes = [
'id' => $id . '-tray',
'data-toolbar-tray' => $id . '-tray',
];
// Merge in module-provided attributes.
if (!isset($element['tray']['#wrapper_attributes'])) {
$element['tray']['#wrapper_attributes'] = [];
}
$element['tray']['#wrapper_attributes'] += $attributes;
$element['tray']['#wrapper_attributes']['class'][] = 'toolbar-tray';
}
$element['tab']['#attributes']['class'][] = 'toolbar-item';
return $element;
}
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
| RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
| RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
| RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
| RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
| RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
| ToolbarItem::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
| ToolbarItem::preRenderToolbarItem | public static | function | Provides markup for associating a tray trigger with a tray element. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.