VerticalTabs

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

File

core/lib/Drupal/Core/Render/Element/VerticalTabs.php, line 50

Namespace

Drupal\Core\Render\Element

Members

Name Modifiers Type Description
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function
PluginBase::$configuration protected property Configuration information passed into the plugin.
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 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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object.
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.
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.
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.
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.
doc_Drupal
2016-10-29 09:53:32
Comments
Leave a Comment

Please login to continue.