class Details
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details
- 10 core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details
- 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'] = array(
'#type' => 'details',
'#title' => $this->t('Author'),
);
$form['author']['name'] = array(
'#type' => 'textfield',
'#title' => $this->t('Name'),
);
Plugin annotation
@RenderElement("details");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\Details extends \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Details
See also
\Drupal\Core\Render\Element\Fieldset
\Drupal]Core\Render\Element\VerticalTabs
23 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.
100 #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.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Details.php, line 39
Namespace
Drupal\Core\Render\ElementView source
class Details extends RenderElement {
/**
* {@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 Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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. | ||
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 | |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.