Default checkbox¶
The checkbox with renderType check is typically a single checkbox or a group of checkboxes.
Its state can be inverted via invert
.
Examples¶
All examples listed here can be found in the extension styleguide.
Example: Simple checkbox with label¶
TCA:
[
'columns' => [
'checkbox_2' => [
'label' => 'checkbox_2',
'description' => 'one checkbox with label',
'config' => [
'type' => 'check',
'items' => [
[
'label' => 'foo',
],
],
],
],
],
]
Copied!
If the checkbox is checked, the value for the field will be 1, if unchecked, it will be 0.
<checkbox_2>
<label>checkbox_2 cols=3</label>
<config>
<type>check</type>
<items type="array">
<numIndex index="0" type="array">
<label>foo1</label>
<value></value>
</numIndex>
<numIndex index="1" type="array">
<label>foo2</label>
<value></value>
</numIndex>
<numIndex index="2" type="array">
<label>foo3</label>
<value></value>
</numIndex>
<numIndex index="3" type="array">
<label>foo4</label>
<value></value>
</numIndex>
</items>
<cols>3</cols>
</config>
</checkbox_2>
Copied!
Example: Four checkboxes in three columns¶
TCA:
[
'columns' => [
'checkbox_12' => [
'label' => 'checkbox_12',
'description' => 'cols=3',
'config' => [
'type' => 'check',
'items' => [
[
'label' => 'foo1',
],
[
'label' => 'foo2',
],
[
'label' => 'foo3',
],
[
'label' => 'foo4',
],
],
'cols' => '3',
],
],
],
]
Copied!
If all checkboxes are checked, the value for the field will be 15 (1
).
Example: Checkboxes with inline floating¶
[
'columns' => [
'checkbox_16' => [
'label' => 'checkbox_16',
'description' => 'cols=inline',
'config' => [
'type' => 'check',
'items' => [
[
'label' => 'Mo',
],
[
'label' => 'Tu',
],
[
'label' => 'We',
],
[
'label' => 'Th',
],
[
'label' => 'Fr',
],
[
'label' => 'Sa',
],
[
'label' => 'Su',
],
],
'cols' => 'inline',
],
],
],
]
Copied!
This will display as many checkbox items as will fit in one row. Without inline, each checkbox would be displayed in a separate row.