UIkitBreadcrumb.php in UIkit Components 8.3

Namespace

Drupal\uikit_components\Element

File

src/Element/UIkitBreadcrumb.php

<?php

namespace Drupal\uikit_components\Element;

use Drupal\Core\Render\Element\RenderElement;
use Drupal\Core\Template\Attribute;

/**
 * Provides a render element for the Breadcrumb component.
 *
 * Properties:
 * - #items: An array of items to be displayed in the breadcrumb. Each item must
 *   contain the text property and can optionally contain the url property to
 *   display the item as a link. Each item can also contain a disabled property
 *   to set the item as disabled using 'disabled' => TRUE.
 *
 * Usage example:
 * @code
 * $build['breadcrumb'] = [
 *   '#type' => 'uikit_breadcrumb',
 *   '#items' => [
 *     [
 *       'text' => t('Item 1'),
 *       'url' => Url::fromRoute('<front>'),
 *     ],
 *     [
 *       'text' => t('Item 2'),
 *       'url' => Url::fromRoute($route_two),
 *     ],
 *     [
 *       'text' => t('Disabled'),
 *       'url' => Url::fromRoute($route_three),
 *       'disabled' => TRUE,
 *     ],
 *     [
 *       'text' => t('Active'),
 *     ],
 *   ],
 * ];
 * @endcode
 *
 * @see template_preprocess_uikit_breadcrumb()
 * @see https://getuikit.com/docs/breadcrumb
 *
 * @ingroup uikit_components_theme_render
 *
 * @RenderElement("uikit_breadcrumb")
 */
class UIkitBreadcrumb extends RenderElement {

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

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

    // Set the attributes for the breadcrumb outer element.
    $element['#attributes']
      ->addClass('uk-breadcrumb');
    foreach ($element['#items'] as $key => $item) {

      // Set the item attributes.
      $item_attributes = new Attribute();
      if (isset($item['disabled']) && $item['disabled']) {
        $item_attributes
          ->addClass('uk-disabled');
      }
      $element['#items'][$key]['attributes'] = $item_attributes;
    }
    return $element;
  }

}

Classes

Name	Description
UIkitBreadcrumb	Provides a render element for the Breadcrumb component.