class Dropbutton

Same name in this branch
  1. 10 core/modules/views/src/Plugin/views/field/Dropbutton.php \Drupal\views\Plugin\views\field\Dropbutton
Same name and namespace in other branches
  1. 9 core/modules/views/src/Plugin/views/field/Dropbutton.php \Drupal\views\Plugin\views\field\Dropbutton
  2. 9 core/lib/Drupal/Core/Render/Element/Dropbutton.php \Drupal\Core\Render\Element\Dropbutton
  3. 8.9.x core/modules/views/src/Plugin/views/field/Dropbutton.php \Drupal\views\Plugin\views\field\Dropbutton
  4. 8.9.x core/lib/Drupal/Core/Render/Element/Dropbutton.php \Drupal\Core\Render\Element\Dropbutton
  5. 11.x core/modules/views/src/Plugin/views/field/Dropbutton.php \Drupal\views\Plugin\views\field\Dropbutton
  6. 11.x core/lib/Drupal/Core/Render/Element/Dropbutton.php \Drupal\Core\Render\Element\Dropbutton

Provides a render element for a set of links rendered as a drop-down button.

By default, this element sets #theme so that the 'links' theme hook is used for rendering, with suffixes so that themes can override this specifically without overriding all links theming. If the #subtype property is provided in your render array with value 'foo', #theme is set to links__dropbutton__foo; if not, it's links__dropbutton; both of these can be overridden by setting the #theme property in your render array. See template_preprocess_links() for documentation on the other properties used in theming; for instance, use element property #links to provide $variables['links'] for theming.

Properties:

  • #links: An array of links to actions. See template_preprocess_links() for documentation the properties of links in this array.
  • #dropbutton_type: A string defining a type of dropbutton variant for styling proposes. Renders as class `dropbutton--#dropbutton_type`.

Usage Example:

$form['actions']['extra_actions'] = [
  '#type' => 'dropbutton',
  '#dropbutton_type' => 'small',
  '#links' => [
    'simple_form' => [
      'title' => $this->t('Simple Form'),
      'url' => Url::fromRoute('fapi_example.simple_form'),
    ],
    'demo' => [
      'title' => $this->t('Build Demo'),
      'url' => Url::fromRoute('fapi_example.build_demo'),
    ],
  ],
];

Hierarchy

Expanded class hierarchy of Dropbutton

See also

\Drupal\Core\Render\Element\Operations

10 string references to 'Dropbutton'
claro_preprocess_views_ui_display_tab_bucket in core/themes/claro/claro.theme
Implements hook_preprocess_HOOK() for views_ui_display_tab_bucket.
Dropbutton::preRenderDropbutton in core/lib/Drupal/Core/Render/Element/Dropbutton.php
Pre-render callback: Attaches the dropbutton library and required markup.
FieldDropbuttonTest::testDropbuttonMarkupShouldNotLeakBetweenRows in core/modules/views/tests/src/Kernel/Handler/FieldDropbuttonTest.php
Tests that dropbutton markup doesn't leak between rows.
views.view.content.yml in core/modules/node/config/optional/views.view.content.yml
core/modules/node/config/optional/views.view.content.yml
views.view.test_content_ajax.yml in core/modules/views/tests/modules/views_test_config/test_views/views.view.test_content_ajax.yml
core/modules/views/tests/modules/views_test_config/test_views/views.view.test_content_ajax.yml

... See full list

File

core/lib/Drupal/Core/Render/Element/Dropbutton.php, line 45

Namespace

Drupal\Core\Render\Element
View source
class Dropbutton extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#pre_render' => [
        [
          $class,
          'preRenderDropbutton',
        ],
      ],
      '#theme' => 'links__dropbutton',
    ];
  }
  
  /**
   * Pre-render callback: Attaches the dropbutton library and required markup.
   */
  public static function preRenderDropbutton($element) {
    $element['#attached']['library'][] = 'core/drupal.dropbutton';
    $element['#attributes']['class'][] = 'dropbutton';
    if (!empty($element['#dropbutton_type'])) {
      $element['#attributes']['class'][] = 'dropbutton--' . $element['#dropbutton_type'];
    }
    if (!isset($element['#theme_wrappers'])) {
      $element['#theme_wrappers'] = [];
    }
    array_unshift($element['#theme_wrappers'], 'dropbutton_wrapper');
    // Enable targeted theming of specific dropbuttons (e.g., 'operations' or
    // 'operations__node').
    if (isset($element['#subtype'])) {
      $element['#theme'] .= '__' . $element['#subtype'];
    }
    return $element;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Dropbutton::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
Dropbutton::preRenderDropbutton public static function Pre-render callback: Attaches the dropbutton library and required markup.
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.