You are here

class Dropbutton in Drupal 10

Same name in this branch
  1. 10 core/lib/Drupal/Core/Render/Element/Dropbutton.php \Drupal\Core\Render\Element\Dropbutton
  2. 10 core/modules/views/src/Plugin/views/field/Dropbutton.php \Drupal\views\Plugin\views\field\Dropbutton
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/Dropbutton.php \Drupal\Core\Render\Element\Dropbutton
  2. 9 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'] = array(
  '#type' => 'dropbutton',
  '#dropbutton_type' => 'small',
  '#links' => array(
    'simple_form' => array(
      'title' => $this
        ->t('Simple Form'),
      'url' => Url::fromRoute('fapi_example.simple_form'),
    ),
    'demo' => array(
      'title' => $this
        ->t('Build Demo'),
      'url' => Url::fromRoute('fapi_example.build_demo'),
    ),
  ),
);

Plugin annotation

@RenderElement("dropbutton");

Hierarchy

Expanded class hierarchy of Dropbutton

See also

\Drupal\Core\Render\Element\Operations

2 string references to 'Dropbutton'
views.view.test_dropbutton.yml in core/modules/views/tests/modules/views_test_config/test_views/views.view.test_dropbutton.yml
core/modules/views/tests/modules/views_test_config/test_views/views.view.test_dropbutton.yml
views_views_data in core/modules/views/views.views.inc
Implements hook_views_data().
4 #type uses of Dropbutton
Actions::preRenderActionsDropbutton in core/lib/Drupal/Core/Render/Element/Actions.php
#pre_render callback for #type 'actions'.
Dropbutton::render in core/modules/views/src/Plugin/views/field/Dropbutton.php
ViewEditForm::getFormBucket in core/modules/views_ui/src/ViewEditForm.php
Add information about a section to a display.
ViewEditForm::renderDisplayTop in core/modules/views_ui/src/ViewEditForm.php
Render the top of the display so it can be updated during ajax operations.

File

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

Namespace

Drupal\Core\Render\Element
View source
class Dropbutton extends RenderElement {

  /**
   * {@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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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.
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.