UIkitArticle.php in UIkit Components 8.3

Namespace

Drupal\uikit_components\Element

File

src/Element/UIkitArticle.php

<?php

namespace Drupal\uikit_components\Element;

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

/**
 * Provides a render element for the Article component.
 *
 * Properties:
 * - #title: The title of the article.
 * - #meta: The metadata of the article, such as author and created date.
 * - #lead: The lead to display before the article content.
 * - #content: The content of the article.
 *
 * Usage example:
 * @code
 * $build['article'] = [
 *   '#type' => 'uikit_article',
 *   '#title' => $this->t('Heading'),
 *   '#meta' => Markup::create($meta),
 *   '#lead' => $this->t('Lorem ipsum dolor sit amet'),
 *   '#content' => Markup::create($content),
 * ];
 * @endcode
 *
 * @see template_preprocess_uikit_article()
 * @see https://getuikit.com/docs/article
 *
 * @ingroup uikit_components_theme_render
 *
 * @RenderElement("uikit_article")
 */
class UIkitArticle extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#title' => NULL,
      '#meta' => NULL,
      '#lead' => NULL,
      '#content' => NULL,
      '#attributes' => new Attribute(),
      '#pre_render' => [
        [
          $class,
          'preRenderUIkitArticle',
        ],
      ],
      '#theme_wrappers' => [
        'uikit_article',
      ],
    ];
  }

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

    // Set the attributes for the article outer element.
    $element['#attributes']
      ->addClass('uk-article');
    return $element;
  }

}

Classes

Name	Description
UIkitArticle	Provides a render element for the Article component.