class Details

Same name in this branch

11.x core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details

Same name and namespace in other branches

9 core/lib/Drupal/Core/Render/Element/Details.php \Drupal\Core\Render\Element\Details
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

Provides a render element for a details element.

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 $custom Confirm that this class has been swapped properly. @property $summary_attributes An array of attributes to apply to the <summary> element.

Attributes

#[RenderElement('details')]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\element_info_test\Render\Element\Details implements \Drupal\Core\Render\Element\RenderElementBase

Expanded class hierarchy of Details

1 file declares its use of Details

ElementInfoTestHooks.php in core/modules/system/tests/modules/element_info_test/src/Hook/ElementInfoTestHooks.php

14 string references to 'Details'

BlockForm::buildVisibilityInterface in core/modules/block/src/BlockForm.php: Helper function for building the visibility UI form.
ClaroVerticalTabsTest::testVerticalTabs in core/tests/Drupal/KernelTests/Core/Theme/ClaroVerticalTabsTest.php: Confirms that Claro can render vertical tabs correctly.
Details::getInfo in core/lib/Drupal/Core/Render/Element/Details.php: Returns the element properties for this element.
EditDetails::buildForm in core/modules/views_ui/src/Form/Ajax/EditDetails.php: Form constructor.
FileTransferAuthorizeForm::setConnectionSettingsDefaults in core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php: Sets the default settings on a file transfer connection form recursively.

... See full list

47 #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.
AdvancedSettingsForm::buildForm in core/modules/views_ui/src/Form/AdvancedSettingsForm.php: Form constructor.
BasicSettingsForm::buildForm in core/modules/views_ui/src/Form/BasicSettingsForm.php: Form constructor.
ClaroVerticalTabsTest::testVerticalTabs in core/tests/Drupal/KernelTests/Core/Theme/ClaroVerticalTabsTest.php: Confirms that Claro can render vertical tabs correctly.

... See full list

File

core/modules/system/tests/modules/element_info_test/src/Render/Element/Details.php, line 27

Namespace

Drupal\element_info_test\Render\Element

View on git.drupalcode.org

View source

class Details extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() : array {
    return [
      '#open' => FALSE,
      '#summary_attributes' => [],
      '#custom' => 'Custom',
    ];
  }
  
  /**
   * 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) : array {
    Element::setAttributes($element, [
      'custom',
    ]);
    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'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.

Breadcrumb