class Details

Same name 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. 11.x 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:

  • #title: The title of the details container. Defaults to "Details".
  • #open: Indicates whether the container should be open by default. Defaults to FALSE.
  • #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'),
];

Hierarchy

Expanded class hierarchy of Details

See also

\Drupal\Core\Render\Element\Fieldset

\Drupal]Core\Render\Element\VerticalTabs

24 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

File

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

Namespace

Drupal\Core\Render\Element
View source 
class Details extends RenderElementBase {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#open' => FALSE,
            '#summary_attributes' => [],
            '#value' => NULL,
            '#process' => [
                [
                    $class,
                    'processGroup',
                ],
                [
                    $class,
                    'processAjaxForm',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderDetails',
                ],
                [
                    $class,
                    'preRenderGroup',
                ],
            ],
            '#theme_wrappers' => [
                'details',
            ],
        ];
    }
    
    /**
     * Adds form element theming to details.
     *
     * @param $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 Modifiers Object type Summary Overriden Title Overrides
Details::getInfo public function Overrides ElementInterface::getInfo
Details::preRenderDetails public static function Adds form element theming to details.
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 Overrides ElementInterface::setAttributes 2

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