class VerticalTabs in Drupal 10

Provides a render element for vertical tabs in a form.

Formats all child and non-child details elements whose #group is assigned this element's name as vertical tabs.

Properties:

• #default_tab: The HTML ID of the rendered details element to be used as the default tab. View the source of the rendered page to determine the ID.

Usage example:

$form['information'] = array(
  '#type' => 'vertical_tabs',
  '#default_tab' => 'edit-publication',
);
$form['author'] = array(
  '#type' => 'details',
  '#title' => $this
    ->t('Author'),
  '#group' => 'information',
);
$form['author']['name'] = array(
  '#type' => 'textfield',
  '#title' => $this
    ->t('Name'),
);
$form['publication'] = array(
  '#type' => 'details',
  '#title' => $this
    ->t('Publication'),
  '#group' => 'information',
);
$form['publication']['publisher'] = array(
  '#type' => 'textfield',
  '#title' => $this
    ->t('Publisher'),
);

Plugin annotation

@FormElement("vertical_tabs");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\VerticalTabs

12 #type uses of VerticalTabs

AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php

Form constructor.

BlockForm::buildVisibilityInterface in core/modules/block/src/BlockForm.php

Helper function for building the visibility UI form.

CKEditor5::buildConfigurationForm in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php

CKEditor::buildConfigurationForm in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php

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/VerticalTabs.php, line 50

Namespace

Drupal\Core\Render\Element

class VerticalTabs extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#default_tab' => '',
      '#process' => [
        [
          $class,
          'processVerticalTabs',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderVerticalTabs',
        ],
      ],
      '#theme_wrappers' => [
        'vertical_tabs',
        'form_element',
      ],
    ];
  }

  /**
   * Prepares a vertical_tabs element for rendering.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   vertical tabs element.
   *
   * @return array
   *   The modified element.
   */
  public static function preRenderVerticalTabs($element) {

    // Do not render the vertical tabs element if it is empty.
    $group = implode('][', $element['#parents']);
    if (!Element::getVisibleChildren($element['group']['#groups'][$group])) {
      $element['#printed'] = TRUE;
    }
    return $element;
  }

  /**
   * Creates a group formatted as vertical tabs.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   details element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processVerticalTabs(&$element, FormStateInterface $form_state, &$complete_form) {
    if (isset($element['#access']) && !$element['#access']) {
      return $element;
    }

    // Inject a new details as child, so that form_process_details() processes
    // this details element like any other details.
    $element['group'] = [
      '#type' => 'details',
      '#theme_wrappers' => [],
      '#parents' => $element['#parents'],
    ];

    // Add an invisible label for accessibility.
    if (!isset($element['#title'])) {
      $element['#title'] = t('Vertical Tabs');
      $element['#title_display'] = 'invisible';
    }
    $element['#attached']['library'][] = 'core/drupal.vertical-tabs';

    // The JavaScript stores the currently selected tab in this hidden
    // field so that the active tab can be restored the next time the
    // form is rendered, e.g. on preview pages or when form validation
    // fails.
    $name = implode('__', $element['#parents']);
    if ($form_state
      ->hasValue($name . '__active_tab')) {
      $element['#default_tab'] = $form_state
        ->getValue($name . '__active_tab');
    }
    $element[$name . '__active_tab'] = [
      '#type' => 'hidden',
      '#default_value' => $element['#default_tab'],
      '#attributes' => [
        'class' => [
          'vertical-tabs__active-tab',
        ],
      ],
    ];

    // Clean up the active tab value so it's not accidentally stored in
    // settings forms.
    $form_state
      ->addCleanValueKey($name . '__active_tab');
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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.
VerticalTabs::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
VerticalTabs::preRenderVerticalTabs	public static	function	Prepares a vertical_tabs element for rendering.
VerticalTabs::processVerticalTabs	public static	function	Creates a group formatted as vertical tabs.