:navigation-title: field.text .. include:: /Includes.rst.txt .. _fluidtypo3-flux-field-text: ========================================= field.text ViewHelper `` ========================================= Textarea FlexForm field ViewHelper .. _fluidtypo3-flux-field-text_arguments: Arguments ========= .. _field.text_name: name ---- :aspect:`DataType` string :aspect:`Required` true :aspect:`Description` Name of the attribute, FlexForm XML-valid tag name string .. _field.text_label: label ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Label for the attribute, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.fields.foobar" based on field name, in scope of extension rendering the Flux form. If field is in an object, use "flux.fluxFormId.objects.objectname.foobar" where "foobar" is the name of the field. .. _field.text_default: default ------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Default value for this attribute .. _field.text_native: native ------ :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this field will treated as a native TCA field (requiring a matching SQL column). If the "name" of this field is an already existing field, that original field will be replaced by this field. If the field is a new field (which doesn't already exist in TCA). You can control where this field visually appears in the editing form by specifying the "position" argument, which supports the same syntax as \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToAllTCAtypes (after:X before:X and replace:X). Note that when declaring a field as "native" it will no longer be rendered as part of the FlexForm where Flux fields are normally rendered. .. _field.text_position: position -------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Only applies if native=1. Specify where in the editing form this field should be, using the syntax of \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToAllTCAtypes (after:X before:X and replace:X). Additionally, allows you to specify a TCA sheet if you want this field to be positioned in a dedicated sheet. Examples: position="after:header", position="replace:header", position="after:header My Sheet" .. _field.text_required: required -------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this attribute must be filled when editing the FCE .. _field.text_exclude: exclude ------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this) .. _field.text_transform: transform --------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Set this to transform your value to this type - integer, array (for csv values), float, DateTime, Vendor\MyExt\Domain\Model\Object or ObjectStorage with type hint. .. _field.text_enabled: enabled ------- :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If FALSE, disables the field in the FlexForm .. _field.text_requestupdate: requestUpdate ------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, the form is force-saved and reloaded when field value changes .. _field.text_displaycond: displayCond ----------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond .. _field.text_inherit: inherit ------- :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider .. _field.text_inheritempty: inheritEmpty ------------ :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider .. _field.text_clear: clear ----- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, a "clear value" checkbox is displayed next to the field which when checked, completely destroys the current field value all the way down to the stored XML value .. _field.text_protect: protect ------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, a "protect value" checkbox is displayed next to the field which when checked, protects the value from being changed if the (normally inherited) field value is changed in a parent record. Has no effect if "inherit" is disabled on the field. .. _field.text_variables: variables --------- :aspect:`DataType` mixed :aspect:`Default` array () :aspect:`Required` false :aspect:`Description` Freestyle variables which become assigned to the resulting Component - can then be read from that Component outside this Fluid template and in other templates using the Form object from this template .. _field.text_extensionname: extensionName ------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context. .. _field.text_config: config ------ :aspect:`DataType` mixed :aspect:`Default` array () :aspect:`Required` false :aspect:`Description` Raw TCA options - passed directly to "config" section of created field and overrides anything generated by the component itself. Can be used to provide options that Flux itself does not support, and can be used to pass root-level arguments for a "userFunc" .. _field.text_validate: validate -------- :aspect:`DataType` string :aspect:`Default` 'trim' :aspect:`Required` false :aspect:`Description` FlexForm-type validation configuration for this input .. _field.text_cols: cols ---- :aspect:`DataType` mixed :aspect:`Default` 85 :aspect:`Required` false :aspect:`Description` Number of columns in editor .. _field.text_rows: rows ---- :aspect:`DataType` mixed :aspect:`Default` 10 :aspect:`Required` false :aspect:`Description` Number of rows in editor .. _field.text_defaultextras: defaultExtras ------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` DEPRECATED, IGNORED - has no function on TYPO3 8.7+. FlexForm-syntax "defaultExtras" definition, example: "richtext[*]:rte_transform[mode=ts_css]" .. _field.text_enablerichtext: enableRichText -------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` Enable the richtext editor (RTE) .. _field.text_rendertype: renderType ---------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Render type allows you to modify the behaviour of text field. At the moment only t3editor and none (works as disabled) are supported but you can create your own. More information: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Text/Index.html#rendertype .. _field.text_format: format ------ :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Format is used with renderType and, at the moment, is just useful if renderType is equals to t3editor. At the moment possible values are: html, typoscript, javascript, css, xml, html, php, sparql, mixed. More information: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Text/Index.html#format .. _field.text_richtextconfiguration: richtextConfiguration --------------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Specifies which configuration to use in combination with EXT:rte_ckeditor.If none is given, PageTSconfig "RTE.tx_flux.preset" and "RTE.default.preset" are used.More information: https://docs.typo3.org/typo3cms/TCAReference/ColumnsConfig/Properties/TextRichtextConfiugration.html .. _field.text_placeholder: placeholder ----------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Placeholder text which vanishes if field is filled and/or field is focused