class ToolbarItem
Same name and namespace in other branches
- 11.x core/modules/toolbar/src/Element/ToolbarItem.php \Drupal\toolbar\Element\ToolbarItem
- 10 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
Provides a toolbar item that is wrapped in markup for common styling.
The 'tray' property contains a renderable array.
Plugin annotation
@RenderElement("toolbar_item");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\toolbar\Element\ToolbarItem extends \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
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
8 #type uses of ToolbarItem
- contextual_toolbar in core/
modules/ contextual/ contextual.module - Implements hook_toolbar().
- hook_toolbar in core/
modules/ toolbar/ toolbar.api.php - Add items to the toolbar menu.
- shortcut_toolbar in core/
modules/ shortcut/ shortcut.module - Implements hook_toolbar().
- toolbar_test_toolbar in core/
modules/ toolbar/ tests/ modules/ toolbar_test/ toolbar_test.module - Implements hook_toolbar().
- toolbar_toolbar in core/
modules/ toolbar/ toolbar.module - Implements hook_toolbar().
File
-
core/
modules/ toolbar/ src/ Element/ ToolbarItem.php, line 15
Namespace
Drupal\toolbar\ElementView source
class ToolbarItem extends RenderElement {
/**
* {@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;
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.