[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’)
1 2
GridRow: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
GridRow: properties: containerClassAttribute: input elementClassAttribute: row elementErrorClassAttribute: error gridColumnClassAutoConfiguration: gridSize: 12 viewPorts: xs: classPattern: 'col-xs-{@numbersOfColumnsToUse}' sm: classPattern: 'col-sm-{@numbersOfColumnsToUse}' md: classPattern: 'col-md-{@numbersOfColumnsToUse}' lg: 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’)
1 2 3 4
GridRow: renderingOptions: _isCompositeFormElement: true _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’)
1 2 3 4
GridRow: renderingOptions: _isCompositeFormElement: true _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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
GridRow: formEditor: editors: 100: identifier: header templateName: Inspector-FormElementHeaderEditor 200: identifier: label templateName: Inspector-TextEditor label: formEditor.elements.GridRow.editor.label.label propertyPath: label 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 9999: identifier: removeButton templateName: Inspector-RemoveElementEditor predefinedDefaults: { } label: formEditor.elements.GridRow.label group: container groupSorting: 300 _isCompositeFormElement: true _isGridRowFormElement: true iconIdentifier: t3-form-icon-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’)
1 2 3 4 5 6
GridRow: formEditor: editors: 100: identifier: header 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’)
1 2 3 4 5 6 7 8
GridRow: formEditor: editors: 200: identifier: label templateName: Inspector-TextEditor label: formEditor.elements.GridRow.editor.label.label 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’)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
GridRow: 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.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’)
1 2 3 4 5 6
GridRow: formEditor: editors: 9999: identifier: removeButton 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’)
1 2 3
GridRow: formEditor: 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’)
1 2 3
GridRow: formEditor: _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.GridContainer.formEditor._isGridRowFormElement
- Data type
- bool
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Default value (for prototype ‘standard’)
1 2 3
GridContainer: formEditor: _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’)
1 2 3
GridRow: formEditor: 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’)
1 2 3
GridRow: formEditor: 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. Thegroup
value must be equal to an array key withinformElementGroups
.
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’)
1 2 3
GridRow: formEditor: 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’)
1 2 3
GridRow: formEditor: iconIdentifier: t3-form-icon-gridrow
- 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