items

items
Type:array
Scope:Display

If set, this array will create an array of checkboxes instead of just a single “on/off” checkbox.

Note

You can have a maximum of 31 checkboxes in such an array and each element is represented by a single bit in the integer value which ultimately goes into the database.

In this array each entry is itself an array where the first entry (index 0) is the label (string or LLL reference). The value sent to the database will be an integer representing a bit mask based on the position of the checkbox in this array.

A basic item looks like this:

'items' => [
   ['Green tomatoes'], // Note these should be LLL references
   ['Red peppers'],
],

Further properties can be set per item, but not all of them apply to all renderTypes:

invertStateDisplay (boolean)
All renderTypes. If set to true, checked / unchecked state are swapped in view: A checkbox is marked checked if the database bit is not set and vice versa.
iconIdentifierChecked (string)
Only if renderType is not set (default): An optional icon shown is selected / on. If not set, a check mark icon is used.
iconIdentifierUnchecked (string)
Only if renderType is not set (default): An optional icon shown selected / on. If not set, no icon is show (check mark icon not displayed).
labelChecked (string)
Mandatory property for renderType checkboxLabeledToggle: Text shown if element is selected / on.
labelUnchecked (string)
Mandatory property for renderType checkboxLabeledToggle: Text shown if element is not selected.

Examples

../../../../_images/Checkbox3.png
'columns' => [
    'checkbox_3' => [
        'exclude' => 1,
        'label' => 'checkbox_3',
        'description' => 'three checkboxes, two with labels, one without',
        'config' => [
            'type' => 'check',
            'items' => [
                [
                    'foo',
                    '',
                ],
                [
                    '',
                    '',
                ],
                [
                    0 => 'foobar',
                    1 => '',
                    'iconIdentifierChecked' => 'content-beside-text-img-below-center',
                    'iconIdentifierUnchecked' => 'content-beside-text-img-below-center',
                ],
            ],
        ],
    ],
]