Checkbox¶

The Checkbox type generates one or more checkbox fields.

It corresponds with the TCA type => 'check'.

SQL overrides via alternativeSql allowed: yes.

Settings¶

default¶

Required:	false
Type:	integer (bit value)
Default:	0

The default value corresponds to a bit value. If you only have one checkbox having 1 or 0 will work to turn it on or off by default. For more than one checkbox you need to calculate the bit representation.

items¶

Required:	false
Type:	array

Only necessary if more than one checkbox is desired. Contains the checkbox elements as separate array items. The label can also be defined as a LLL-reference.

Example:

items:
  - label: 'The first'
  - label: 'The second'
  - label: 'The third'

For advanced configuration refer to the TCA documentation.

Examples¶

Minimal¶

name: example/checkbox
fields:
  - identifier: checkbox
    type: Checkbox

Advanced / use case¶

Multiple checkboxes:

name: example/checkbox
fields:
  - identifier: checkbox
    type: Checkbox
    items:
      - label: 'The first'
      - label: 'The second'
      - label: 'The third'
    default: 2
    cols: 3

Toggle checkbox:

name: example/checkbox
fields:
  - identifier: toggle
    type: Checkbox
    renderType: checkboxToggle
    default: 1