You are here

Home » API reference » UIkit Components 8.3 » preprocess.inc

function template_preprocess_uikit_button in UIkit Components 8.3

Prrpares variables for UIkit Button templates.

Default template: uikit-button.html.twig.

Parameters

$variables:: An associative array containing:

  • element: An associative array containing:

    • #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.

See also

\Drupal\uikit_components\Element\UIkitButton

https://getuikit.com/docs/button

Related topics

Render API Overview
Overview of the UIkit Components Theme system and Render API.

File

includes/preprocess.inc, line 214
Set up variables to be placed within the template (.html.twig) files.

Code

function template_preprocess_uikit_button(&$variables) {
  $element = $variables['element'];

  // Set the attributes for the badge.
  $variables['attributes'] = $element['#attributes'];
  if ($element['#text']) {
    $variables['text'] = $element['#text'];
  }
  if ($element['#url']) {
    $variables['button_type'] = 'a';
  }
  else {
    $variables['button_type'] = 'button';
  }
}