Textarea 

The Textarea type is for multi line text input. A Rich Text Editor can be enabled.

Settings 

Name Type Default Required
string
string
integer 5
boolean false
boolean true
boolean false
string
boolean false
integer 30
boolean false
string
object
object
object
boolean
string
integer
integer
boolean false
boolean false
string
object
string virtual

default

default
Type
string

Default value set if a new record is created.

placeholder

placeholder
Type
string

Placeholder text for the field. Can also be used as automatic language key in labels.xlf. See here for more information.

rows

rows
Type
integer
Default
5

Abstract value for the height of the <textarea> field. Max value is 20.

required

required
Type
boolean
Default
false

If set, the field will become mandatory.

searchable

searchable
Type
boolean
Default
true

If set to false, the field will not be considered in backend search.

enableRichtext

enableRichtext
Type
boolean
Default
false

If set to true, the system renders a Rich Text Editor if that is enabled for the editor (default: yes), and if a suitable editor extension is loaded (default: rte_ckeditor).

If either of these requirements is not met, the system falls back to a <textarea> field.

richtextConfiguration

richtextConfiguration
Type
string

The value is a key in $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets'] array and specifies the YAML configuration source field used for that RTE field. It does not make sense without having property enableRichtext set to true.

Extension rte_ckeditor registers three presets: default, minimal and full and points to YAML files with configuration details.

Integrators may override for instance the default key to point to an own YAML file which will affect all core backend RTE instances to use that configuration.

If this property is not specified for an RTE field, the system will fall back to the default configuration.

behaviour.allowLanguageSynchronization

behaviour.allowLanguageSynchronization
Type
boolean
Default
false

Allows to select if localization uses custom or default language value.

cols

cols
Type
integer
Default
30

Abstract width of the textarea field. Minimum 10, maximum 50.

enableTabulator

enableTabulator
Type
boolean
Default
false

Allows the use of tab characters inside the textarea.

eval

eval
Type
string

Configuration of field evaluation. For example trim to strip whitespace from the value before saving.

fieldControl

fieldControl
Type
object

fieldInformation

fieldInformation
Type
object

fieldWizard

fieldWizard
Type
object

fixedFont

fixedFont
Type
boolean

Renders the textarea with a fixed-width (monospace) font.

is_in

is_in
Type
string

Evaluates whether the entered text contains only characters from this string.

max

max
Type
integer

Maximum number of characters allowed.

min

min
Type
integer

Minimum number of characters required. Empty values are still allowed; combine with required to enforce a non-empty value.

nullable

nullable
Type
boolean
Default
false

Allows the database field to store a NULL value.

readOnly

readOnly
Type
boolean
Default
false

Renders the field in a way that the user can see the value but cannot edit it.

renderType

renderType
Type
string

Selects an alternative rendering for the textarea. Possible values:

  • codeEditor
  • textTable
  • belayoutwizard

valuePicker

valuePicker
Type
object

Renders a select box next to the field from which predefined values can be inserted. Requires an items array of objects with label and value keys.

Example:

valuePicker:
  items:
    - label: 'Job offer general'
      value: 'Want to join our team? Take the initiative!'
    - label: 'Job offer specific'
      value: 'We are looking for ...'
Copied!

wrap

wrap
Type
string
Default
virtual

Wrapping mode of the textarea. Possible values:

  • virtual
  • off

Examples 

Minimal 

name: example/textarea
fields:
  - identifier: textarea
    type: Textarea
Copied!

Richtext field 

name: example/richtext
fields:
  - identifier: textarea
    type: Textarea
    enableRichtext: true
    richtextConfiguration: full
Copied!

Advanced / use case 

name: example/textarea
fields:
  - identifier: textarea
    type: Textarea
    default: "Default value"
    placeholder: "Placeholder text"
    required: true
    rows: 15
Copied!