[Checkbox]¶

Properties¶

implementationClassName¶

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.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')

Checkbox:
  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.Checkbox.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')

Checkbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: add-on
    elementErrorClassAttribute: error
    value: 1

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

properties.elementClassAttribute¶

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.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')

Checkbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: add-on
    elementErrorClassAttribute: error
    value: 1

Description: A CSS class written to the form element.

properties.elementDescription¶

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.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.Checkbox.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')

Checkbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: add-on
    elementErrorClassAttribute: error
    value: 1

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

properties.value¶

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.value

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

Checkbox:
  properties:
    containerClassAttribute: 'input checkbox'
    elementClassAttribute: add-on
    elementErrorClassAttribute: error
    value: 1

Description: The value of the checkbox which should be sent to the server.

formEditor¶

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

Checkbox:
  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
      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
        propertyPath: properties.fluidAdditionalAttributes.required
        propertyValue: required
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
    predefinedDefaults: {  }
    label: formEditor.elements.Checkbox.label
    group: select
    groupSorting: 100
    iconIdentifier: form-checkbox

formEditor.editors.100¶

Option path: TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.100
Data type: array/ [FormElementHeaderEditor]
Needed by: Backend (form editor)
Mandatory: Recommended

Default value (for prototype 'standard')

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

formEditor.editors.200¶

Option path: TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.200
Data type: array/ [TextEditor]
Needed by: Backend (form editor)
Mandatory: Recommended

Default value (for prototype 'standard')

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

formEditor.editors.230¶

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.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

formEditor.editors.700¶

Option path: TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.700
Data type: array/ [GridColumnViewPortConfigurationEditor]
Needed by: Backend (form editor)
Mandatory: Recommended

Default value (for prototype 'standard')

Checkbox:
  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

formEditor.editors.800¶

Option path: TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.800
Data type: array/ [RequiredValidatorEditor]
Needed by: Backend (form editor)
Mandatory: Recommended

Default value (for prototype 'standard')

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

formEditor.editors.9999¶

Option path: TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.9999
Data type: array/ [RemoveElementEditor]
Needed by: Backend (form editor)
Mandatory: Recommended

Default value (for prototype 'standard')

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

formEditor.predefinedDefaults¶

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

Checkbox:
  formEditor:
    predefinedDefaults: {  }

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

formEditor.label¶

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

Checkbox:
  formEditor:
    label: formEditor.elements.Checkbox.label

Good to know

"Translate form editor settings"

Description

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

formEditor.group¶

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

Checkbox:
  formEditor:
    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.Checkbox.formEditor.groupSorting

Data type

int

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')

Checkbox:
  formEditor:
    groupSorting: 100

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

formEditor.iconIdentifier¶

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

Checkbox:
  formEditor:
    iconIdentifier: form-checkbox

Description

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