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
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of UIkitButton
See also
template_preprocess_uikit_button()
https://getuikit.com/docs/button
Related topics
File
- src/
Element/ UIkitButton.php, line 48
Namespace
Drupal\uikit_components\ElementView source
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:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UIkitButton:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
UIkitButton:: |
public static | function | Pre-render callback: Sets the button attributes. |