class UIkitButton in UIkit Components 8.3

Provides a render element for the Button component.

Properties:

• #text: The text to display in the button.
• #url: The url to use in the button, if the button should be rendered in an

 <a> 

element. If omitted, the button will be rendered in a

 <button> 

element.

• #style: The style of the button. Possible values:
  • default: Default button style.
  • primary: Indicates the primary action.
  • secondary: Indicates an important action.
  • danger: Indicates a dangerous or negative action.
  • text: Applies an alternative, typographic style.
  • link: Makes a

 <button> 

look like an

 <a> 

element. Defaults to "default".

• #size: The size of the button. Possible values are "small" and "large".
• #full_width: A boolean indicating if the button will take up the full width of the parent element. Defaults to FALSE.
• #disabled: A boolean indicating whether the button is disabled or not.

Usage example:

$build['button'] = [
  '#type' => 'uikit_button',
  '#text' => t('Button'),
  '#url' => Url::fromRoute('<front>')
    ->toString(),
  '#style' => 'primary',
  '#size' => 'large',
];

Plugin annotation

@RenderElement("uikit_button");

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\UIkitButton

See also

template_preprocess_uikit_button()

https://getuikit.com/docs/button

Related topics

Render API Overview

Overview of the UIkit Components Theme system and Render API.

File

src/Element/UIkitButton.php, line 48

Namespace

Drupal\uikit_components\Element

class UIkitButton extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#text' => NULL,
      '#url' => NULL,
      '#style' => 'default',
      '#size' => NULL,
      '#full_width' => FALSE,
      '#disabled' => FALSE,
      '#attributes' => new Attribute(),
      '#pre_render' => [
        [
          $class,
          'preRenderUIkitButton',
        ],
      ],
      '#theme_wrappers' => [
        'uikit_button',
      ],
    ];
  }

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

    // Set the attributes for the button element.
    $element['#attributes']
      ->addClass('uk-button');
    $element['#attributes']
      ->addClass('uk-button-' . $element['#style']);
    if (!empty($element['#size'])) {
      $element['#attributes']
        ->addClass('uk-button-' . $element['#size']);
    }
    if ($element['#full_width']) {
      $element['#attributes']
        ->addClass('uk-width-1-1');
    }
    if ($element['#disabled']) {
      $element['#attributes']
        ->setAttribute('disabled', '');
    }
    if (!empty($element['#url'])) {
      $element['#attributes']
        ->setAttribute('href', $element['#url']);
    }
    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.
UIkitButton::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
UIkitButton::preRenderUIkitButton	public static	function	Pre-render callback: Sets the button attributes.