[GridRow]

Properties

implementationClassName

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.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')
1GridRow:
2  implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\GridRow
Description

Classname which implements the form element.

properties.containerClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.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')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Description

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

properties.elementClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.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')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Description

A CSS class written to the form element.

properties.elementErrorClassAttribute

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.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')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Description

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

properties.gridColumnClassAutoConfiguration.gridSize

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.gridSize

Data type

int

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

Yes

Default value (for prototype 'standard')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Description

The grid size of the CSS grid system (bootstrap by default).

properties.gridColumnClassAutoConfiguration.viewPorts

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts

Data type

array

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')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Related options
Description

Each configuration key within properties.gridColumnClassAutoConfiguration.viewPorts represents an viewport of the CSS grid system (bootstrap by default).

properties.gridColumnClassAutoConfiguration.viewPorts.[*].classPattern

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts.<gridColumnClassAutoConfigurationViewPortIdentifier>.classPattern

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

Yes

Default value (for prototype 'standard')
 1GridRow:
 2  properties:
 3    containerClassAttribute: input
 4    elementClassAttribute: row
 5    elementErrorClassAttribute: error
 6    gridColumnClassAutoConfiguration:
 7      gridSize: 12
 8      viewPorts:
 9        xs:
10          classPattern: 'col-{@numbersOfColumnsToUse}'
11        sm:
12          classPattern: 'col-sm-{@numbersOfColumnsToUse}'
13        md:
14          classPattern: 'col-md-{@numbersOfColumnsToUse}'
15        lg:
16          classPattern: 'col-lg-{@numbersOfColumnsToUse}'
Related options
Description

Defines the CSS class pattern for the CSS grid system. Each viewport classPattern will be wrapped around a form element within a grid row. The {@numbersOfColumnsToUse} placeholder will be replaced by the number of columns which the respective form element should occupy. The number of columns which the respective form element should occupy has to defined within the respective form elements within a GridRow. If a form element has no number of columns defined, the {@numbersOfColumnsToUse} are calculated automatically.

renderingOptions._isCompositeFormElement

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.renderingOptions._isCompositeFormElement

Data type

bool

Needed by

Frontend

Overwritable within form definition

Yes

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

No

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  renderingOptions:
3    _isCompositeFormElement: true
4    _isGridRowFormElement: true
Description

Internal control setting to define that the form element contains child form elements.

renderingOptions._isGridRowFormElement

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.renderingOptions._isGridRowFormElement

Data type

bool

Needed by

Frontend

Overwritable within form definition

Yes

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

No

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  renderingOptions:
3    _isCompositeFormElement: true
4    _isGridRowFormElement: true
Description

Internal control setting.

formEditor

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1GridRow:
 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.GridRow.editor.label.label
11        propertyPath: label
12      700:
13        identifier: gridColumnViewPortConfiguration
14        templateName: Inspector-GridColumnViewPortConfigurationEditor
15        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
16        configurationOptions:
17          viewPorts:
18            10:
19              viewPortIdentifier: xs
20              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
21            20:
22              viewPortIdentifier: sm
23              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
24            30:
25              viewPortIdentifier: md
26              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
27            40:
28              viewPortIdentifier: lg
29              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
30          numbersOfColumnsToUse:
31            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
32            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
33            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
34      9999:
35        identifier: removeButton
36        templateName: Inspector-RemoveElementEditor
37    predefinedDefaults: {  }
38    label: formEditor.elements.GridRow.label
39    group: container
40    groupSorting: 300
41    _isCompositeFormElement: true
42    _isGridRowFormElement: true
43    iconIdentifier: form-gridrow

formEditor.editors.100

Option path

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

Data type

array/ [FormElementHeaderEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

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

formEditor.editors.200

Option path

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

Data type

array/ [TextEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

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

formEditor.editors.700

Option path

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

Data type

array/ [GridColumnViewPortConfigurationEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
 1GridRow:
 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.9999

Option path

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

Data type

array/ [RemoveElementEditor]

Needed by

Backend (form editor)

Mandatory

Recommended

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

formEditor.predefinedDefaults

Option path

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

Data type

array

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    predefinedDefaults: {  }
Description

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

formEditor._isCompositeFormElement

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor._isCompositeFormElement

Data type

bool

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    _isCompositeFormElement: true
Description

Internal control setting to define that the form element contains child form elements.

formEditor._isGridRowFormElement

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor._isGridRowFormElement

Data type

bool

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    _isGridRowFormElement: true
Description

todo

formEditor.label

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    label: formEditor.elements.GridRow.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.GridRow.formEditor.group

Data type

string

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    group: container
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.GridRow.formEditor.groupSorting

Data type

int

Needed by

Backend (form editor)

Mandatory

Recommended

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    groupSorting: 300
Description

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

formEditor.iconIdentifier

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')
1GridRow:
2  formEditor:
3    iconIdentifier: form-gridrow
Description

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