class UIkitCard in UIkit Components 8.3
Provides a render element for the Card component.
Properties:
- #content: The content of the card.
- #title (optional): The title of the card.
- #style (optional): The style of the card. Defaults to "default".
- #hover (optional): Add hover effect to card. Defaults to FALSE.
- #size (optional): The padding to apply to the card.
- #badge (optional): The badge to apply to the card.
- #header (optional): The heading to add to the card.
- #footer (optional): The footer to add to the card.
- #media (optional): An associative array containing:
- alignment: Where the media is aligned in the card. Possible values are top or bottom. Left and right alignment is not currently available.
- image_url: The URL for the image to display in the card.
If #media is set, #header and #footer will be ignored. This prevents the layout from being disrupted when #media is set. Since left and right media layouts are too complex, left and right alignment values are currently unavailable. See the documentation link below for more information.
Usage example:
$build['card'] = [
'#type' => 'uikit_card',
'#title' => $this
->t('Title'),
'#content' => Markup::create($content),
'#style' => 'default',
'#hover' => TRUE,
'#size' => 'large',
'#badge' => $this
->t('Badge'),
'#header' => $this
->t('Heading'),
'#footer' => Markup::create($footer),
];
Plugin annotation
@RenderElement("uikit_card");
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\UIkitCard
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of UIkitCard
See also
template_preprocess_uikit_card()
https://getuikit.com/docs/card
Related topics
File
- src/
Element/ UIkitCard.php, line 52
Namespace
Drupal\uikit_components\ElementView source
class UIkitCard extends RenderElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#title' => NULL,
'#content' => NULL,
'#attributes' => new Attribute(),
'#style' => 'default',
'#hover' => FALSE,
'#size' => NULL,
'#badge' => NULL,
'#header' => NULL,
'#footer' => NULL,
'#media' => NULL,
'#pre_render' => [
[
$class,
'preRenderUIkitCard',
],
],
'#theme_wrappers' => [
'uikit_card',
],
];
}
/**
* Pre-render callback: Sets the card attributes.
*
* Doing so during pre_render gives modules a chance to alter the card.
*
* @param array $element
* A renderable array.
*
* @return array
* A renderable array.
*/
public static function preRenderUIkitCard($element) {
// Set the attributes for the card outer element.
$element['#attributes']
->addClass('uk-card');
$element['#attributes']
->addClass('uk-card-' . $element['#style']);
if ($element['#hover']) {
$element['#attributes']
->addClass('uk-card-hover');
}
if (!empty($element['#size'])) {
$element['#attributes']
->addClass('uk-card-' . $element['#size']);
}
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. | |
UIkitCard:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
UIkitCard:: |
public static | function | Pre-render callback: Sets the card attributes. |