Default checkbox

The checkbox with renderType check is typically a single checkbox or a group of checkboxes.

Its state can be inverted via invertStateDisplay.

Examples

All examples listed here can be found in the extension styleguide.

Example: Simple checkbox with label

../../../_images/Checkbox2.png

TCA:

EXT:styleguide/Configuration/TCA/tx_styleguide_elements_basic.php
[
    'columns' => [
        'checkbox_2' => [
            'label' => 'checkbox_2',
            'description' => 'one checkbox with label',
            'config' => [
                'type' => 'check',
                'items' => [
                    [
                        'label' => 'foo',
                    ],
                ],
            ],
        ],
    ],
]

If the checkbox is checked, the value for the field will be 1, if unchecked, it will be 0.

FlexForm:

EXT:styleguide/Configuration/TCA/tx_styleguide_flex.php
<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>

Example: Four checkboxes in three columns

../../../_images/Checkbox12.png

TCA:

EXT:styleguide/Configuration/TCA/tx_styleguide_elements_basic.php
[
    'columns' => [
        'checkbox_12' => [
            'label' => 'checkbox_12',
            'description' => 'cols=3',
            'config' => [
                'type' => 'check',
                'items' => [
                    [
                        'label' => 'foo1',
                    ],
                    [
                        'label' => 'foo2',
                    ],
                    [
                        'label' => 'foo3',
                    ],
                    [
                        'label' => 'foo4',
                    ],
                ],
                'cols' => '3',
            ],
        ],
    ],
]

If all checkboxes are checked, the value for the field will be 15 (1 | 2 | 4 | 8).

Example: Checkboxes with inline floating

../../../_images/Checkbox16.png
EXT:styleguide/Configuration/TCA/tx_styleguide_elements_basic.php
[
    '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',
            ],
        ],
    ],
]

This will display as many checkbox items as will fit in one row. Without inline, each checkbox would be displayed in a separate row.