class Details

Same name in this branch
  1. 11.x core/modules/system/tests/modules/element_info_test/src/Render/Element/Details.php \Drupal\element_info_test\Render\Element\Details
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details
  2. 8.9.x core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details
  3. 10 core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details

Provides a render element for a details element, similar to a fieldset.

Fieldsets can only be used in forms, while details elements can be used outside of forms. Users click on the title to open or close the details element, showing or hiding the contained elements.

Properties:

@property $title The title of the details container. Defaults to "Details". @property $open Indicates whether the container should be open by default. Defaults to FALSE. @property $summary_attributes An array of attributes to apply to the <summary> element.

Usage example:

$form['author'] = [
  '#type' => 'details',
  '#title' => $this->t('Author'),
];
$form['author']['name'] = [
  '#type' => 'textfield',
  '#title' => $this->t('Name'),
];

Attributes

#[RenderElement('details')]

Hierarchy

Expanded class hierarchy of Details

See also

\Drupal\Core\Render\Element\Fieldset

\Drupal]Core\Render\Element\VerticalTabs

27 string references to 'Details'
BlockForm::buildVisibilityInterface in core/modules/block/src/BlockForm.php
Helper function for building the visibility UI form.
ChooseBlockController::build in core/modules/layout_builder/src/Controller/ChooseBlockController.php
Provides the UI for choosing a new block.
ClaroPreRender::container in core/themes/claro/src/ClaroPreRender.php
Prerender callback for container elements.
ClaroPreRender::verticalTabs in core/themes/claro/src/ClaroPreRender.php
Prerender callback for Vertical Tabs element.
ClaroVerticalTabsTest::testVerticalTabs in core/tests/Drupal/KernelTests/Core/Theme/ClaroVerticalTabsTest.php
Confirms that Claro can render vertical tabs correctly.

... See full list

113 #type uses of Details
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php
Form constructor.
ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php
Form constructor.
AddFormBase::buildCurrentSelectionArea in core/modules/media_library/src/Form/AddFormBase.php
Returns a render array containing the current selection.
AdvancedSettingsForm::buildForm in core/modules/views_ui/src/Form/AdvancedSettingsForm.php
Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Details.php, line 42

Namespace

Drupal\Core\Render\Element
View source
class Details extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#open' => FALSE,
      '#summary_attributes' => [],
      '#value' => NULL,
      '#process' => [
        [
          static::class,
          'processGroup',
        ],
        [
          static::class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          static::class,
          'preRenderDetails',
        ],
        [
          static::class,
          'preRenderGroup',
        ],
      ],
      '#theme_wrappers' => [
        'details',
      ],
    ];
  }
  
  /**
   * Adds form element theming to details.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   details.
   *
   * @return array
   *   The modified element.
   */
  public static function preRenderDetails($element) {
    Element::setAttributes($element, [
      'id',
    ]);
    // The .js-form-wrapper class is required for #states to treat details like
    // containers.
    static::setAttributes($element, [
      'js-form-wrapper',
      'form-wrapper',
    ]);
    // Collapsible details.
    $element['#attached']['library'][] = 'core/drupal.collapse';
    // Open the detail if specified or if a child has an error.
    if (!empty($element['#open']) || !empty($element['#children_errors'])) {
      $element['#attributes']['open'] = 'open';
    }
    // Do not render optional details elements if there are no children.
    if (isset($element['#parents'])) {
      $group = implode('][', $element['#parents']);
      if (!empty($element['#optional']) && !Element::getVisibleChildren($element['#groups'][$group])) {
        $element['#printed'] = TRUE;
      }
    }
    return $element;
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
Details::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Details::preRenderDetails public static function Adds form element theming to details.
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
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. 1
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
RenderElementBase::$renderParent protected property The parent element.
RenderElementBase::$renderParentName protected property The parent key.
RenderElementBase::$storage protected property The storage.
RenderElementBase::addChild public function Adds a child render element. Overrides ElementInterface::addChild
RenderElementBase::changeType public function Change the type of the element. Overrides ElementInterface::changeType
RenderElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
RenderElementBase::createChild public function Creates a render object and attaches it to the current render object. Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager protected function Returns the element info manager.
RenderElementBase::getChild public function Gets a child. Overrides ElementInterface::getChild
RenderElementBase::getChildren public function Returns child elements. Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage public function Initialize storage. Overrides ElementInterface::initializeInternalStorage
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::removeChild public function Removes a child. Overrides ElementInterface::removeChild
RenderElementBase::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2
RenderElementBase::setType protected function Set type on initialize. 1
RenderElementBase::toRenderable public function Returns a render array. Overrides ElementInterface::toRenderable
RenderElementBase::__construct public function Constructs a new render element object. Overrides PluginBase::__construct 6
RenderElementBase::__get public function Magic method: gets a property value.
RenderElementBase::__isset public function Magic method: checks if a property value is set.
RenderElementBase::__set public function Magic method: Sets a property value.
RenderElementBase::__sleep public function Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset public function Magic method: unsets a property value.
RenderElementBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

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