[MultiCheckbox]¶

implementationClassName¶

Option path

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')

MultiCheckbox:
  implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement

Copied!

Description

Classname which implements the form element.

properties.containerClassAttribute¶

Option path

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')

MultiCheckbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: ''
    elementErrorClassAttribute: error

Copied!

Description

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

properties.elementClassAttribute¶

Option path

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')

MultiCheckbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: ''
    elementErrorClassAttribute: error

Copied!

Description

A CSS class written to the form element.

properties.elementDescription¶

Option path

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

• "Custom form element implementations"
• "Translate form definition"

Description

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

properties.elementErrorClassAttribute¶

Option path

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')

MultiCheckbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: ''
    elementErrorClassAttribute: error

Copied!

Description

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

formEditor¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.label.label
        propertyPath: label
      230:
         identifier: elementDescription
         templateName: Inspector-TextEditor
         label: formEditor.elements.FormElement.editor.elementDescription.label
         propertyPath: properties.elementDescription
      300:
        identifier: options
        templateName: Inspector-PropertyGridEditor
        label: formEditor.elements.SelectionMixin.editor.options.label
        propertyPath: properties.options
        isSortable: true
        enableAddRow: true
        enableDeleteRow: true
        removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle
        removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage
        shouldShowPreselectedValueColumn: multiple
        multiSelection: true
      700:
        identifier: gridColumnViewPortConfiguration
        templateName: Inspector-GridColumnViewPortConfigurationEditor
        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
        configurationOptions:
          viewPorts:
            10:
              viewPortIdentifier: xs
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
            20:
              viewPortIdentifier: sm
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
            30:
              viewPortIdentifier: md
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
            40:
              viewPortIdentifier: lg
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
          numbersOfColumnsToUse:
            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
      800:
        identifier: requiredValidator
        templateName: Inspector-RequiredValidatorEditor
        label: formEditor.elements.FormElement.editor.requiredValidator.label
        validatorIdentifier: NotEmpty
      900:
        identifier: validators
        templateName: Inspector-ValidatorsEditor
        label: formEditor.elements.MultiSelectionMixin.editor.validators.label
        selectOptions:
          10:
            value: ''
            label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label
          20:
            value: Count
            label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
    predefinedDefaults:
      properties:
        options: {  }
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: Integer
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: Integer
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor
    label: formEditor.elements.MultiCheckbox.label
    group: select
    groupSorting: 400
    iconIdentifier: form-multi-checkbox

Copied!

formEditor.editors.100¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.100

Data type

array/ [FormElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor

Copied!

formEditor.editors.200¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.200

Data type

array/ [TextEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.label.label
        propertyPath: label

Copied!

formEditor.editors.230¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.230

Data type

array/ [TextEditor]

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value (for prototype 'standard')

Date:
  formEditor:
    editors:
      230:
        identifier: elementDescription
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.elementDescription.label
        propertyPath: properties.elementDescription

Copied!

formEditor.editors.300¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.300

Data type

array/ [PropertyGridEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      300:
        identifier: options
        templateName: Inspector-PropertyGridEditor
        label: formEditor.elements.SelectionMixin.editor.options.label
        propertyPath: properties.options
        isSortable: true
        enableAddRow: true
        enableDeleteRow: true
        removeLastAvailableRowFlashMessageTitle: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageTitle
        removeLastAvailableRowFlashMessageMessage: formEditor.elements.SelectionMixin.editor.options.removeLastAvailableRowFlashMessageMessage
        shouldShowPreselectedValueColumn: multiple
        multiSelection: true

Copied!

formEditor.editors.700¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.700

Data type

array/ [GridColumnViewPortConfigurationEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      700:
        identifier: gridColumnViewPortConfiguration
        templateName: Inspector-GridColumnViewPortConfigurationEditor
        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
        configurationOptions:
          viewPorts:
            10:
              viewPortIdentifier: xs
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
            20:
              viewPortIdentifier: sm
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
            30:
              viewPortIdentifier: md
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
            40:
              viewPortIdentifier: lg
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
          numbersOfColumnsToUse:
            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText

Copied!

formEditor.editors.800¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.800

Data type

array/ [RequiredValidatorEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      800:
        identifier: requiredValidator
        templateName: Inspector-RequiredValidatorEditor
        label: formEditor.elements.FormElement.editor.requiredValidator.label
        validatorIdentifier: NotEmpty
        propertyPath: properties.fluidAdditionalAttributes.required
        propertyValue: required

Copied!

formEditor.editors.900¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.900

Data type

array/ [ValidatorsEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      900:
        identifier: validators
        templateName: Inspector-ValidatorsEditor
        label: formEditor.elements.MultiSelectionMixin.editor.validators.label
        selectOptions:
          10:
            value: ''
            label: formEditor.elements.MultiSelectionMixin.editor.validators.EmptyValue.label
          20:
            value: Count
            label: formEditor.elements.MultiSelectionMixin.editor.validators.Count.label

Copied!

formEditor.editors.9999¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.editors.9999

Data type

array/ [RemoveElementEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    editors:
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor

Copied!

formEditor.predefinedDefaults¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.predefinedDefaults

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    predefinedDefaults:
      properties:
        options: {  }

Copied!

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

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.propertyCollections.validators.10

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: Integer
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: Integer
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor

Copied!

formEditor.propertyCollections.validators.10.identifier¶

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count

Copied!

Good to know

• "Inspector"
• "<validatorIdentifier>"

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

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')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.MultiSelectionMixin.validators.Count.editor.header.label

Copied!

formEditor.propertyCollections.validators.10.editors.100¶

Option path

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')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: Integer

Copied!

formEditor.propertyCollections.validators.10.editors.100¶

Option path

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')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: Integer

Copied!

formEditor.propertyCollections.validators.10.editors.9999¶

Option path

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')

MultiCheckbox:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: Count
          editors:
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor

Copied!

formEditor.label¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.label

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    label: formEditor.elements.MultiCheckbox.label

Copied!

Good to know

• "Translate form editor settings"

Description

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

formEditor.group¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group

Data type

string

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    group: select

Copied!

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

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.groupSorting

Data type

int

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    groupSorting: 400

Copied!

Description

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

formEditor.iconIdentifier¶

Option path

prototypes.<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.iconIdentifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

MultiCheckbox:
  formEditor:
    iconIdentifier: form-multi-checkbox

Copied!

Description

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

• "Inspector [FormElementHeaderEditor]".
• "Abstract view formelement templates".
• Tree component.
• "new element" Modal