[formElementsDefinition]

Properties

[formElementsDefinition]

Option path

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

Data type

array

Needed by

Frontend/ Backend (form editor)

Mandatory

Yes

Default value
1prototypes:
2  <prototypeIdentifier>:
3    formElementsDefinition:
4      [...]
Good to know
Description

Array which defines the available form elements. Every key within this array is called the <formElementTypeIdentifier>.

<formElementTypeIdentifier>

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
 1prototypes:
 2  standard:
 3    Form:
 4      [...]
 5    Page:
 6      [...]
 7    SummaryPage:
 8      [...]
 9    Fieldset:
10      [...]
11    GridRow:
12      [...]
13    Text:
14      [...]
15    Password:
16      [...]
17    AdvancedPassword:
18      [...]
19    Textarea:
20      [...]
21    Honeypot:
22      [...]
23    Hidden:
24      [...]
25    Email:
26      [...]
27    Telephone:
28      [...]
29    Url:
30      [...]
31    Number:
32      [...]
33    Date:
34      [...]
35    Checkbox:
36      [...]
37    MultiCheckbox:
38      [...]
39    MultiSelect:
40      [...]
41    RadioButton:
42      [...]
43    SingleSelect:
44      [...]
45    DatePicker:
46      [...]
47    StaticText:
48      [...]
49    ContentElement:
50      [...]
51    FileUpload:
52      [...]
53    ImageUpload:
54      [...]
Good to know
Description

This array key identifies a form element. This identifier could be used to attach a form element to a form.

Common <formElementTypeIdentifier> properties

defaultValue

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.defaultValue

Data type

string/ array

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

undefined

Description

If set this string/ array will be used as default value of the form element. Array is in place for multi value elements (e.g. the MultiSelect form element).

implementationClassName

Option path

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

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

Classname which implements the form element.

renderingOptions.translation.translationFiles

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.translation.translationFiles

Data type

string/ array

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Filesystem path(s) to translation files which should be searched for form element property translations. If translationFiles is undefined, - "TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFiles" will be used.

renderingOptions.translation.translatePropertyValueIfEmpty

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingoptions.translation.translatepropertyvalueifempty

Data type

bool

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

true

Good to know
Description

If set to false, the form element property translation will be skipped if the form element property value is empty.

renderingOptions.templateName

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.templateName

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

(see concrete element configuration)

Default value

undefined

Good to know
Description

Set templateName to define a custom template name which should be used instead of the <formElementTypeIdentifier>.

properties

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties

Data type

array

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with form element specific properties.

properties.elementDescription

Option path

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

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Undefined

Good to know
Description

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

properties.fluidAdditionalAttributes

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.fluidAdditionalAttributes

Data type

array

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

The values within this array are directly used within the form element ViewHelper's property additionalAttributes.

properties.gridColumnClassAutoConfiguration

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration

Data type

array

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Undefined

Related options
Description

If the form element lies within a GridRow you can define the number of columns which the form element should occupy. Each viewPorts configuration key has to match with on ofe the defined viewports within TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts

 1 gridColumnClassAutoConfiguration:
 2   viewPorts:
 3     lg:
 4       numbersOfColumnsToUse: '2'
 5     md:
 6       numbersOfColumnsToUse: '3'
 7     sm:
 8       numbersOfColumnsToUse: '4'
 9     xs:
10       numbersOfColumnsToUse: '5'

label

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.label

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

The label of the form element.

formEditor

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

No (but recommended)

Default value

Depends (see concrete element configuration)

Description

Array with configurations for the form editor

formEditor.predefinedDefaults

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

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

formEditor.propertyCollections

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with configurations for property collections for the form element.

formEditor.propertyCollections.validators

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with configurations for available validators for a form element.

formEditor.propertyCollections.validators.[*].identifier

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].identifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

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.[*].editors

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].editors

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with available inspector editors for this validator.

formEditor.propertyCollections.finishers

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with configurations for available finisher for a form definition.

formEditor.propertyCollections.finishers.[*].identifier

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier

Data type

string

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Identifies the finisher which should be attached to the form definition. Must be equal to an existing <finisherIdentifier>.

formEditor.propertyCollections.finishers.[*].editors

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].editors

Data type

string

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know
Description

Array with available inspector editors for this finisher.

formEditor.label

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

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

formEditor.group

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

No

Related options
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.<formElementTypeIdentifier>.formEditor.groupSorting

Data type

int

Needed by

Backend (form editor)

Mandatory

No

Default value

Depends (see concrete element configuration)

Description

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

formEditor.iconIdentifier

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Description

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

formEditor.editors

Concrete configurations