class UIkitDescriptionList in UIkit Components 8.3

Provides a render element for the Description List component.

Properties:

• #items: An array of items to be displayed in the description list. Each item can be an associative array with the properties "term" and "description", or be a string if the definition should be displayed with the previous item's term.
• #divider: A boolean indicating whether to add a horizontal line between list items. Defaults to FALSE.

Usage example:

$build['description_list'] = [
  '#type' => 'uikit_description_list',
  '#items' => [
    [
      'term' => t('Item 1'),
      'description' => t($item_one),
    ],
    [
      'term' => t('Item 2'),
      'description' => t($item_two),
    ],
    t($item_three),
  ],
  '#divider' => TRUE,
];

Plugin annotation

@RenderElement("uikit_description_list");

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\uikit_components\Element\UIkitDescriptionList

See also

template_preprocess_uikit_definition_list()

https://getuikit.com/docs/definition-list

Related topics

Render API Overview

Overview of the UIkit Components Theme system and Render API.

File

src/Element/UIkitDescriptionList.php, line 45

Namespace

Drupal\uikit_components\Element

class UIkitDescriptionList extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#items' => NULL,
      '#divider' => FALSE,
      '#attributes' => new Attribute(),
      '#pre_render' => [
        [
          $class,
          'preRenderUIkitDescriptionList',
        ],
      ],
      '#theme_wrappers' => [
        'uikit_description_list',
      ],
    ];
  }

  /**
   * Pre-render callback: Sets the description list attributes.
   *
   * Doing so during pre_render gives modules a chance to alter the description
   * list.
   *
   * @param array $element
   *   A renderable array.
   *
   * @return array
   *   A renderable array.
   */
  public static function preRenderUIkitDescriptionList($element) {

    // Set the attributes for the definition list.
    $element['#attributes']
      ->addClass('uk-description-list');
    if ($element['#divider']) {

      // Add the divider class to the definition list.
      $element['#attributes']
        ->addClass('uk-description-list-divider');
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	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.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.	1
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.
UIkitDescriptionList::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
UIkitDescriptionList::preRenderUIkitDescriptionList	public static	function	Pre-render callback: Sets the description list attributes.