[TextEditor]

Introduction

Shows a single line textfield.

Properties

templateName

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Related options
value

Inspector-TextEditor

Good to know
Description

The inline HTML template which is used for this inspector editor. Must be equal to an existing array key within TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formEditor.formEditorPartials and must be started with 'Inspector-' by convention.

identifier

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.identifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

Identifies the current inspector editor within the current form element. The identifier is a text of your choice but must be unique within the optionpath TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.

label

Option path

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

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

The label for this inspector editor which is shown within the inspector component.

propertyPath

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.propertyPath

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Depends (see concrete element configuration)

Good to know
Description

The path to the property of the form element which should be written by this inspector editor.

doNotSetIfPropertyValueIsEmpty

Data type

bool

Needed by

Backend (form editor)

Mandatory

No

Good to know
Description

If set to true then the property which should be written through this inspector editor will be removed within the form definition if the value from the inspector editor is empty instead of writing an empty value ('') for this property.

propertyValidators

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Related options
Good to know
Description

This inspector editors is able to validate it's value through JavaScript methods. This JavaScript validators can be registered through getFormEditorApp().addPropertyValidationValidator(). The first method argument is the identifier for such a validator. Every array value within propertyValidators must be equal to such an identifier.

For example:

propertyValidators:
  10: 'Integer'
  20: 'FormElementIdentifierWithinCurlyBracesExclusive'

propertyValidatorsMode

Data type

string

Needed by

Backend (form editor)

Mandatory

No

Default value

AND

possible values

OR/ AND

Good to know
Description

If set to 'OR' then at least one validator must be valid to accept the inspector editor value. If set to 'AND' then all validators must be valid.

fieldExplanationText

Data type

string

Needed by

Backend (form editor)

Mandatory

No

Good to know
Description

A text which is shown at the bottom of the inspector editor.

additionalElementPropertyPaths

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Good to know
Description

An array which holds property paths which should be written in addition to the propertyPath option.

For example:

additionalElementPropertyPaths:
  10: 'properties.fluidAdditionalAttributes.maxlength'