[MultiCheckbox]

Properties

implementationClassName

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.implementationClassName

Data type

string

Needed by

Frontend/ Backend (form editor)

Overwritable within form definition

No

form editor can write this property into the form definition (for prototype 'standard')

No

Mandatory

Yes

Default value (for prototype 'standard')
1MultiCheckbox:
2  implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement
Description

Classname which implements the form element.

properties.containerClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.containerClassAttribute

Data type

string

Needed by

Frontend/ Backend (form editor)

Overwritable within form definition

Yes

form editor can write this property into the form definition (for prototype 'standard')

No

Mandatory

No

Default value (for prototype 'standard')
1MultiCheckbox:
2  properties:
3    containerClassAttribute: 'input checkbox'
4    elementClassAttribute: ''
5    elementErrorClassAttribute: error
Description

A CSS class which is typically wrapped around the form elements.

properties.elementClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.elementClassAttribute

Data type

string

Needed by

Frontend/ Backend (form editor)

Overwritable within form definition

Yes

form editor can write this property into the form definition (for prototype 'standard')

No

Mandatory

No

Default value (for prototype 'standard')
1MultiCheckbox:
2  properties:
3    containerClassAttribute: 'input checkbox'
4    elementClassAttribute: ''
5    elementErrorClassAttribute: error
Description

A CSS class written to the form element.

properties.elementDescription

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.elementDescription

Data type

string

Needed by

Frontend/ Backend (form editor)

Overwritable within form definition

Yes

Form editor can write this property into the form definition (for prototype 'standard')

Yes

Mandatory

No

Default value (for prototype 'standard')

Undefined

Good to know
Description

Set a description of the form element. By default, it is displayed below the form element.

properties.elementErrorClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.properties.elementErrorClassAttribute

Data type

string

Needed by

Frontend/ Backend (form editor)

Overwritable within form definition

Yes

form editor can write this property into the form definition (for prototype 'standard')

No

Mandatory

No

Default value (for prototype 'standard')
1MultiCheckbox:
2  properties:
3    containerClassAttribute: 'input checkbox'
4    elementClassAttribute: ''
5    elementErrorClassAttribute: error
Description

A CSS class which is written to the form element if validation errors exists.

formEditor

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
  1MultiCheckbox:
  2  formEditor:
  3    editors:
  4      100:
  5        identifier: header
  6        templateName: Inspector-FormElementHeaderEditor
  7      200:
  8        identifier: label
  9        templateName: Inspector-TextEditor
 10        label: formEditor.elements.FormElement.editor.label.label
 11        propertyPath: label
 12      230:
 13         identifier: elementDescription
 14         templateName: Inspector-TextEditor
 15         label: formEditor.elements.FormElement.editor.elementDescription.label
 16         propertyPath: properties.elementDescription
 17      300:
 18        identifier: options
 19        templateName: Inspector-PropertyGridEditor
 20        label: formEditor.elements.SelectionMixin.editor.options.label
 21        propertyPath: properties.options
 22        isSortable: true
 23        enableAddRow: true
 24        enableDeleteRow: true
 25        removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle
 26        removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage
 27        shouldShowPreselectedValueColumn: multiple
 28        multiSelection: true
 29      700:
 30        identifier: gridColumnViewPortConfiguration
 31        templateName: Inspector-GridColumnViewPortConfigurationEditor
 32        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
 33        configurationOptions:
 34          viewPorts:
 35            10:
 36              viewPortIdentifier: xs
 37              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
 38            20:
 39              viewPortIdentifier: sm
 40              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
 41            30:
 42              viewPortIdentifier: md
 43              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
 44            40:
 45              viewPortIdentifier: lg
 46              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
 47          numbersOfColumnsToUse:
 48            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
 49            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
 50            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
 51      800:
 52        identifier: requiredValidator
 53        templateName: Inspector-RequiredValidatorEditor
 54        label: formEditor.elements.FormElement.editor.requiredValidator.label
 55        validatorIdentifier: NotEmpty
 56      900:
 57        identifier: validators
 58        templateName: Inspector-ValidatorsEditor
 59        label: formEditor.elements.MultiSelectionMixin.editor.validators.label
 60        selectOptions:
 61          10:
 62            value: ''
 63            label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label
 64          20:
 65            value: Count
 66            label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label
 67      9999:
 68        identifier: removeButton
 69        templateName: Inspector-RemoveElementEditor
 70    predefinedDefaults:
 71      properties:
 72        options: {  }
 73    propertyCollections:
 74      validators:
 75        10:
 76          identifier: Count
 77          editors:
 78            100:
 79              identifier: header
 80              templateName: Inspector-CollectionElementHeaderEditor
 81              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label
 82            200:
 83              identifier: minimum
 84              templateName: Inspector-TextEditor
 85              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
 86              propertyPath: options.minimum
 87              propertyValidators:
 88                10: Integer
 89            300:
 90              identifier: maximum
 91              templateName: Inspector-TextEditor
 92              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
 93              propertyPath: options.maximum
 94              propertyValidators:
 95                10: Integer
 96            9999:
 97              identifier: removeButton
 98              templateName: Inspector-RemoveElementEditor
 99    label: formEditor.elements.MultiCheckbox.label
100    group: select
101    groupSorting: 400
102    iconIdentifier: form-multi-checkbox

formEditor.editors.100

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.100

Data type

array/ [FormElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    editors:
4      100:
5        identifier: header
6        templateName: Inspector-FormElementHeaderEditor

formEditor.editors.200

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.200

Data type

array/ [TextEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    editors:
4      200:
5        identifier: label
6        templateName: Inspector-TextEditor
7        label: formEditor.elements.FormElement.editor.label.label
8        propertyPath: label

formEditor.editors.230

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.230

Data type

array/ [TextEditor]

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value (for prototype 'standard')
1Date:
2  formEditor:
3    editors:
4      230:
5        identifier: elementDescription
6        templateName: Inspector-TextEditor
7        label: formEditor.elements.FormElement.editor.elementDescription.label
8        propertyPath: properties.elementDescription

formEditor.editors.300

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.300

Data type

array/ [PropertyGridEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    editors:
 4      300:
 5        identifier: options
 6        templateName: Inspector-PropertyGridEditor
 7        label: formEditor.elements.SelectionMixin.editor.options.label
 8        propertyPath: properties.options
 9        isSortable: true
10        enableAddRow: true
11        enableDeleteRow: true
12        removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle
13        removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage
14        shouldShowPreselectedValueColumn: multiple
15        multiSelection: true

formEditor.editors.700

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.700

Data type

array/ [GridColumnViewPortConfigurationEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    editors:
 4      700:
 5        identifier: gridColumnViewPortConfiguration
 6        templateName: Inspector-GridColumnViewPortConfigurationEditor
 7        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
 8        configurationOptions:
 9          viewPorts:
10            10:
11              viewPortIdentifier: xs
12              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
13            20:
14              viewPortIdentifier: sm
15              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
16            30:
17              viewPortIdentifier: md
18              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
19            40:
20              viewPortIdentifier: lg
21              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
22          numbersOfColumnsToUse:
23            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
24            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
25            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText

formEditor.editors.800

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.800

Data type

array/ [RequiredValidatorEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    editors:
 4      800:
 5        identifier: requiredValidator
 6        templateName: Inspector-RequiredValidatorEditor
 7        label: formEditor.elements.FormElement.editor.requiredValidator.label
 8        validatorIdentifier: NotEmpty
 9        propertyPath: properties.fluidAdditionalAttributes.required
10        propertyValue: required

formEditor.editors.900

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.900

Data type

array/ [ValidatorsEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    editors:
 4      900:
 5        identifier: validators
 6        templateName: Inspector-ValidatorsEditor
 7        label: formEditor.elements.MultiSelectionMixin.editor.validators.label
 8        selectOptions:
 9          10:
10            value: ''
11            label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label
12          20:
13            value: Count
14            label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label

formEditor.editors.9999

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.9999

Data type

array/ [RemoveElementEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    editors:
4      9999:
5        identifier: removeButton
6        templateName: Inspector-RemoveElementEditor

formEditor.predefinedDefaults

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.predefinedDefaults

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    predefinedDefaults:
4      properties:
5        options: {  }
Description

Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.

formEditor.propertyCollections.validators.10

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    propertyCollections:
 4      validators:
 5        10:
 6          identifier: Count
 7          editors:
 8            100:
 9              identifier: header
10              templateName: Inspector-CollectionElementHeaderEditor
11              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label
12            200:
13              identifier: minimum
14              templateName: Inspector-TextEditor
15              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
16              propertyPath: options.minimum
17              propertyValidators:
18                10: Integer
19            300:
20              identifier: maximum
21              templateName: Inspector-TextEditor
22              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
23              propertyPath: options.maximum
24              propertyValidators:
25                10: Integer
26            9999:
27              identifier: removeButton
28              templateName: Inspector-RemoveElementEditor

formEditor.propertyCollections.validators.10.identifier

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.identifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    propertyCollections:
4      validators:
5        10:
6          identifier: Count
Good to know
Description

Identifies the validator which should be attached to the form element. Must be equal to an existing <validatorIdentifier>.

formEditor.propertyCollections.validators.10.editors.100

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100

Data type

array/ [CollectionElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    propertyCollections:
 4      validators:
 5        10:
 6          identifier: Count
 7          editors:
 8            100:
 9              identifier: header
10              templateName: Inspector-CollectionElementHeaderEditor
11              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label

formEditor.propertyCollections.validators.10.editors.100

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100

Data type

array/ [CollectionElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    propertyCollections:
 4      validators:
 5        10:
 6          identifier: Count
 7          editors:
 8            200:
 9              identifier: minimum
10              templateName: Inspector-TextEditor
11              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
12              propertyPath: options.minimum
13              propertyValidators:
14                10: Integer

formEditor.propertyCollections.validators.10.editors.100

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.100

Data type

array/ [CollectionElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    propertyCollections:
 4      validators:
 5        10:
 6          identifier: Count
 7          editors:
 8            300:
 9              identifier: maximum
10              templateName: Inspector-TextEditor
11              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
12              propertyPath: options.maximum
13              propertyValidators:
14                10: Integer

formEditor.propertyCollections.validators.10.editors.9999

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10.editors.9999

Data type

array/ [RemoveElementEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1MultiCheckbox:
 2  formEditor:
 3    propertyCollections:
 4      validators:
 5        10:
 6          identifier: Count
 7          editors:
 8            9999:
 9              identifier: removeButton
10              templateName: Inspector-RemoveElementEditor

formEditor.label

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.label

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    label: formEditor.elements.MultiCheckbox.label
Good to know
Description

This label will be shown within the "new element" Modal.

formEditor.group

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group

Data type

string

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    group: select
Default value

Depends (see concrete element configuration)

Description

Define within which group within the form editor "new Element" modal the form element should be shown. The group value must be equal to an array key within formElementGroups.

formEditor.groupSorting

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.groupSorting

Data type

int

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    groupSorting: 400
Description

The position within the formEditor.group for this form element.

formEditor.iconIdentifier

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.iconIdentifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1MultiCheckbox:
2  formEditor:
3    iconIdentifier: form-multi-checkbox
Description

An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry. This icon will be shown within