Collection
extends Component
in package
Table of Contents
- $align : string
- $color : string
- $icon : string|null
- $items : mixed
- $keys : bool
- $label : string|null
- __construct() : void
- Create a new Collection component instance.
- render() : View|string
- Get the view / contents that represent the component.
Properties
$align
public
string
$align
= 'left'
$color
public
string
$color
= 'is-info'
$icon
public
string|null
$icon
= null
$items
public
mixed
$items
$keys
public
bool
$keys
= true
$label
public
string|null
$label
= null
Methods
__construct()
Create a new Collection component instance.
public
__construct(mixed $items[, bool $keys = true ][, string $color = 'is-info' ][, string $align = 'left' ][, string|null $label = null ][, string|null $icon = null ]) : void
Parameters
- $items : mixed
-
The collection of items to display
- $keys : bool = true
-
Whether to show array keys (default: true)
- $color : string = 'is-info'
-
The color theme of the collection (default: 'is-info')
- $align : string = 'left'
-
Text alignment within the collection (default: 'left')
- $label : string|null = null
-
Optional label for the collection
- $icon : string|null = null
-
Optional icon for the collection (default: 'short_text' if label is set)
Return values
void —render()
Get the view / contents that represent the component.
public
render() : View|string