Flux: Fluid Integration

Flux: Fluid Integration

Extension key

flux

Package name

fluidtypo3/flux

Version

11.0

Language

en

Author

Claus Due, Björn Fromme, Cedric Ziel & Contributors

License

This document is published under the Creative Commons BY 4.0 license.

Rendered

Mon, 15 Sep 2025 08:47:40 +0000

Flux automates integration of Fluid with TYPO3 and makes Fluid the entry point for developers. The name "Flux" has multiple meanings but in this context, it mainly refers to the gel-like fluid used when soldering components together in electronic hardware, making it easier to create a bond between components and improves the durability of the bond.

Table of Contents:

fluidtypo3/flux

  • 4 ViewHelpers documented
  • 4 Sub namespaces

field ViewHelper <flux:field>

FlexForm field ViewHelper

Defines a single field data structure.

Arguments

type

DataType
string
Required
true
Description
TCA field type

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
Description
Label for field

description

DataType
string
Required
false
Description
Field description

exclude

DataType
boolean
Required
false
Description
Set to FALSE if field is not an "exclude" field

config

DataType
mixed
Default
array ()
Required
false
Description
TCA "config" array

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

onChange

DataType
string
Required
false
Description
TCA onChange instruction

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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.

protect

DataType
boolean
Required
false
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.

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

form ViewHelper <flux:form>

FlexForm configuration container ViewHelper

Arguments

id

DataType
string
Required
true
Description
Identifier of this Flexible Content Element, /[a-z0-9]/i allowed.

label

DataType
string
Required
false
Description
Label for the form, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId", in scope of extension rendering the Flux form.

description

DataType
string
Required
false
Description
Short description of the purpose/function of this form

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, features which use this form can elect to skip it. Respect for this flag depends on the feature using the form.

variables

DataType
mixed
Default
array ()
Required
false
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

options

DataType
mixed
Required
false
Description
Custom options to be assigned to Form object - valid values depends on the. See docs of extension in which you use this feature. Can also be set using flux:form.option as child of flux:form.

localLanguageFileRelativePath

DataType
string
Default
'/Resources/Private/Language/locallang.xlf'
Required
false
Description
Relative (from extension) path to locallang file containing labels for the LLL values used in this form.

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

grid ViewHelper <flux:grid>

Grid container ViewHelper.

Use <flux:grid.row> with nested <flux:grid.column> tags to define a tabular layout.

The grid is then rendered automatically in the preview section of the content element, or as page columns if used in page templates.

For frontend rendering, use flux:content.render.

Define Page and Content elements

Name is used to identify columns and fetch e.g. translations from XLF files.

<flux:grid>
<flux:grid.row>
<flux:grid.column colPos="0" name="Main" colspan="3" style="width: 75%" /> <flux:grid.column colPos="1" name="Secondary" colspan="1" style="width: 25%" />

</flux:grid.row>

</flux:grid>

Rendering

<v:content.render column="0" /> <v:content.render column="1" />

Arguments

name

DataType
string
Default
'grid'
Required
false
Description
Optional name of this grid - defaults to "grid"

label

DataType
string
Required
false
Description
Optional label for this grid - defaults to an LLL value (reported if it is missing)

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

inline ViewHelper <flux:inline>

Inline Fluid rendering ViewHelper

Renders Fluid code stored in a variable, which you normally would have to render before assigning it to the view. Instead you can do the following (note, extremely simplified use case):

$view->assign('variable', 'value of my variable'); $view->assign('code', 'My variable: {variable}');

And in the template:

{code -> flux:inline()}

Which outputs:

My variable: value of my variable

You can use this to pass smaller and dynamic pieces of Fluid code to templates, as an alternative to creating new partial templates.

Arguments

code

DataType
string
Required
false
Description
Fluid code to be rendered as if it were part of the template rendering it. Can be passed as inline argument or tag content

content.get ViewHelper <flux:content.get>

Gets all child content of a record based on area.

The elements are already rendered, they just need to be output.

Example: Render all child elements with a border

fluidcontent element with one column of child elements. Each element gets a red border:

<f:section name="Configuration">
<flux:grid>
<flux:grid.row>
<flux:grid.column name="teaser" colPos="0"/>

</flux:grid.row>

</flux:grid>

</f:section>

<f:section name="Main">
<f:for each="{flux:content.get(area:'teaser')}" as="element">
<div style="border: 1px solid red">
<f:format.raw>{element}</f:format.raw>

</div>

</f:for>

</f:section>

Arguments

area

DataType
string
Required
true
Description
Name or "colPos" value of the content area to render

limit

DataType
integer
Required
false
Description
Optional limit to the number of content elements to render

offset

DataType
integer
Required
false
Description
Optional offset to the limit

order

DataType
string
Default
'sorting'
Required
false
Description
Optional sort order of content elements - RAND() supported

sortDirection

DataType
string
Default
'ASC'
Required
false
Description
Optional sort direction of content elements

as

DataType
string
Required
false
Description
Variable name to register, then render child content and insert all results as an array of records

loadRegister

DataType
mixed
Required
false
Description
List of LOAD_REGISTER variable

render

DataType
boolean
Default
true
Required
false
Description
Optional returning variable as original table rows

hideUntranslated

DataType
boolean
Required
false
Description
Exclude untranslated records

content.render ViewHelper <flux:content.render>

Renders all child content of a record based on the area name.

The area is the name attribute of the <grid.column> that shall be rendered.

Example: Render all child elements of one grid column

fluidcontent element with one column of child elements:

<f:section name="Configuration">
<flux:grid>
<flux:grid.row>
<flux:grid.column name="teaser" colPos="0"/>

</flux:grid.row>

</flux:grid>

</f:section>

<f:section name="Main">
<div style="border: 1px solid red">
<flux:content.render area="teaser"/>

</div>

</f:section>

Arguments

area

DataType
string
Required
true
Description
Name or "colPos" value of the content area to render

limit

DataType
integer
Required
false
Description
Optional limit to the number of content elements to render

offset

DataType
integer
Required
false
Description
Optional offset to the limit

order

DataType
string
Default
'sorting'
Required
false
Description
Optional sort order of content elements - RAND() supported

sortDirection

DataType
string
Default
'ASC'
Required
false
Description
Optional sort direction of content elements

as

DataType
string
Required
false
Description
Variable name to register, then render child content and insert all results as an array of records

loadRegister

DataType
mixed
Required
false
Description
List of LOAD_REGISTER variable

render

DataType
boolean
Default
true
Required
false
Description
Optional returning variable as original table rows

hideUntranslated

DataType
boolean
Required
false
Description
Exclude untranslated records

field.checkbox ViewHelper <flux:field.checkbox>

Checkbox FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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.controllerActions ViewHelper <flux:field.controllerActions>

ControllerActions ViewHelper

Renders a FlexForm select field with options fetched from requested extensionName/pluginName and other settings.

There are three basic ways of adding selection options:

  • You can use the "extensionName" and "pluginName" to render all possible actions from an Extbase plugin that you've defined. It doesn't have to be your own plugin - if for example you are rendering actions from EXT:news or another through your own plugin.
  • Or you can use the "actions" argument which is an array: {ControllerName: 'action1,action2,action3', OtherControllerName: 'action1'}
  • And you can extend any of the two methods above with the "subActions" parameter, which allows you to extend the allowed actions whenever the specified combination of ControllerName + actionName is encountered. Example: actions="{ControllerName: 'action1,action2'}" subActions="{ControllerName: {action1: 'action3,action4'}}" Gives options: ControllerName->action1,action3,action4 with LLL values based on "action1" ControllerName->action2 with LLL values based on "action2" By default Flux will create one option per action when reading Controller actions - using "subActions" it becomes possible to add additional actions to the list of allowed actions that the option will contain, as opposed to having only one action per option.

And there are a few ways to limit the options that are displayed:

  • You can use "excludeActions" to specify an array in the same syntax used by the "actions" argument, these are then excluded.
  • You can specifiy the "controllerName" argument in which case only actions from that Controller are displayed.

And there are a couple of ways to define/resolve labels for actions:

  • You can add an LLL label in your locallang_db file: lowercasepluginname.lowercasecontrollername.actionfunctionname example index: myext.articlecontroller.show
  • You can do nothing, in which case the very first line of the PHP doc-comment of each action method is used. This value can even be an LLL:file reference (in case you don't want to use the pattern above - but beware this is somewhat expensive processing)
  • Or you can do nothing at all, not even add a doc comment, in which case the Controller->action syntax is used instead.

Marking actions that have required arguments (which cause errors if rendered on a page that is accessible through a traditional menu) is possible but is deactivated for LLL labels; if you use LLL labels and your action requires an argument, be user friendly and note so in the LLL label or docs as applies.

Lastly, you can set a custom name for the field in which case the value does not trigger the Extbase SwitchableControllerActions feature but instead works as any other Flux FlexForm field would.

To use the field just place it in your Flux form (but in almost all cases leave out the "name" argument which is required on all other field types at the time of writing this). Where the field is placed is not important; the order and the sheet location don't matter.

Arguments

name

DataType
string
Default
'switchableControllerActions'
Required
false
Description
Name of the field

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Optional, full list of items to display - note: if used, this overrides any automatic option filling!

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

renderType

DataType
string
Default
'selectSingle'
Required
false
Description
Rendering type as applies in FormEngine/TCA

showIconTable

DataType
boolean
Required
false
Description
If TRUE shows the option icons as table beneath the select

controllerExtensionName

DataType
string
Required
false
Description
Name of the Extbase extension that contains the Controller to parse, ex. MyExtension. In vendor based extensions use dot, ex. Vendor.MyExtension

pluginName

DataType
string
Required
false
Description
Name of the Extbase plugin that contains Controller definitions to parse, ex. MyPluginName

controllerName

DataType
string
Required
false
Description
Optional extra limiting of actions displayed - if used, field only displays actions for this controller name - ex Article(Controller) or FrontendUser(Controller) - the Controller part is implied

actions

DataType
mixed
Default
array ()
Required
false
Description
Array of "ControllerName" => "csv,of,actions" which are allowed. If used, does not require the use of an ExtensionName and PluginName (will use the one specified in your current plugin automatically)

excludeActions

DataType
mixed
Default
array ()
Required
false
Description
Array of "ControllerName" => "csv,of,actions" which must be excluded

prefixOnRequiredArguments

DataType
string
Default
'*'
Required
false
Description
A short string denoting that the method takes arguments, ex * (which should then be explained in the documentation for your extension about how to setup your plugins

disableLocalLanguageLabels

DataType
boolean
Required
false
Description
If TRUE, disables LLL label usage and just uses the class comment or Controller->action syntax

localLanguageFileRelativePath

DataType
string
Default
'/Resources/Private/Language/locallang_db.xml'
Required
false
Description
Relative (from extension $extensionName) path to locallang file containing the action method labels

subActions

DataType
mixed
Default
array ()
Required
false
Description
Array of sub actions {ControllerName: {list: 'update,delete'}, OtherController: {new: 'create'}} which ' .
'are also allowed but not presented as options when the mapped action is selected (in example: if ' . 'ControllerName->list is selected, ControllerName->update and ControllerName->delete are allowed - but ' . 'cannot be selected).

separator

DataType
string
Required
false
Description
Separator string (glue) for Controller->action values, defaults to "->". Empty values result in default being used.

field.custom ViewHelper <flux:field.custom>

Custom FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

userFunc

DataType
string
Default
'FluidTYPO3\Flux\UserFunction\HtmlOutput->renderField'
Required
false
Description
User function to render the Closure built by this ViewHelper

renderType

DataType
string
Required
false
Description
Render type (TCA renderType) - required on TYPO3 9.5 and above. Render type must be registered as FormEngine node type. See https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/FormEngine/Rendering/Index.html

arguments

DataType
mixed
Required
false
Description
Optional array of arguments to pass to the UserFunction building this field

field.dateTime ViewHelper <flux:field.dateTime>

Input FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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.file ViewHelper <flux:field.file>

Group (select supertype) FlexForm field ViewHelper, subtype "file"

Select and render an image

<flux:field.file name="settings.image" allowed="jpg,png,svg" showThumbnails="1" />

Then use <f:image> to render the image in the frontend:

<f:image src="{settings.image}"/>

alt and title tags are not loaded from the file's meta data record. Use <flux:field.inline.fal> if you want this feature.

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

maxSize

DataType
integer
Required
false
Description
Maximum file size allowed in KB

allowed

DataType
string
Required
false
Description
Defines a list of file types allowed in this field

disallowed

DataType
string
Required
false
Description
Defines a list of file types NOT allowed in this field

uploadFolder

DataType
string
Required
false
Description
Upload folder to use for copied/directly uploaded files

showThumbnails

DataType
boolean
Required
false
Description
If TRUE, displays thumbnails for selected values

useFalRelation

DataType
boolean
Required
false
Description
Use a fal relation instead of a simple file path

internalType

DataType
string
Default
'file_reference'
Required
false
Description
Internal type (TCA internal_type) to use for the field. Defaults to file_reference but can be set to file to support file uploading

field.inline ViewHelper <flux:field.inline>

Inline-style FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Required
true
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box - this field on the foreign_table usually has the type "select" and also has a foreign_table defined.

foreignSortby

DataType
string
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Default
array ()
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Required
false
Description
Name of the opposite field related to a proper mm relation

collapseAll

DataType
boolean
Required
false
Description
If true, all child records are shown as collapsed.

expandSingle

DataType
boolean
Required
false
Description
Show only one expanded record at any time. If a new record is expanded, all others are collapsed.

newRecordLinkAddTitle

DataType
boolean
Required
false
Description
Add the foreign table's title to the 'Add new' link (ie. 'Add new (sometable)')

newRecordLinkPosition

DataType
string
Default
'top'
Required
false
Description
Where to show 'Add new' link. Can be 'top', 'bottom', 'both' or 'none'.

useCombination

DataType
boolean
Required
false
Description
For use on bidirectional relations using an intermediary table. In combinations, it's possible to edit '
. 'attributes and the related child record.

useSortable

DataType
boolean
Required
false
Description
Allow manual sorting of records.

showPossibleLocalizationRecords

DataType
boolean
Required
false
Description
Show unlocalized records which are in the original language, but not yet localized.

showRemovedLocalizationRecords

DataType
boolean
Required
false
Description
Show records which were once localized but do not exist in the original language anymore.

enabledControls

DataType
mixed
Required
false
Description
Associative array with the keys 'info', 'new', 'dragdrop', 'sort', 'hide', delete' and 'localize'. '
. 'Set either one to TRUE or FALSE to show or hide it.

headerThumbnail

DataType
mixed
Required
false
Description
Associative array with header thumbnail.

foreignMatchFields

DataType
mixed
Required
false
Description
The fields and values of the child record which have to match. For FAL the field/key is "fieldname" and the value has to be defined.

foreignTypes

DataType
mixed
Required
false
Description
Overrides the "types" TCA array of the target table with this array (beware! must be specified fully in order to work!). Expects an array of arrays; indexed by type number - each array containing for example a "showitem" CSV list value of field names to be shown when inline-editing the related record.

levelLinksPosition

DataType
string
Required
false
Description
Level links position.

field.input ViewHelper <flux:field.input>

Input FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

eval

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
32
Required
false
Description
Size of field

maxCharacters

DataType
integer
Required
false
Description
Maximum number of characters allowed

minimum

DataType
integer
Required
false
Description
Minimum value for integer type fields

maximum

DataType
integer
Required
false
Description
Maximum value for integer type fields

placeholder

DataType
string
Required
false
Description
Placeholder text which vanishes if field is filled and/or field is focused

field.multiRelation ViewHelper <flux:field.multiRelation>

Select one or more database records from several tables.

In comparison to RelationViewHelper, only the list with selected items is visible on the left. The right side contains a "browse" button that opens a popup.

Related: RelationViewHelper.

Example: Select from multiple tables

Select pages and content elements:

<flux:field.multiRelation name="settings.records"
table="pages,tt_content" maxItems="5" />

Example: Content element selector with autocomplete

Add a wizard to search for content elements, instead of opening a popup:

<flux:field.multiRelation name="settings.elements"
table="tt_content" maxItems="5">

<flux:wizard.suggest /> </flux:field.multiRelation>

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Required
true
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box - this field on the foreign_table usually has the type "select" and also has a foreign_table defined.

foreignSortby

DataType
string
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Default
array ()
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Required
false
Description
Name of the opposite field related to a proper mm relation

field.none ViewHelper <flux:field.none>

None field ViewHelper

Makes a read-only component which supports a default value but which cannot be edited.

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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.radio ViewHelper <flux:field.radio>

Radio FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
true
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

renderType

DataType
string
Default
'selectSingle'
Required
false
Description
Rendering type as applies in FormEngine/TCA

showIconTable

DataType
boolean
Required
false
Description
If TRUE shows the option icons as table beneath the select

field.relation ViewHelper <flux:field.relation>

Select one or multiple database records from one table.

Features a two-list style that shows all selectable items in a list on the right side, and all selected items in a list on the left side.

Related: MultiRelationViewHelper.

Example: Select a content element

If put inside a fluidpages "Configuration" section, the following code allows selecting a content element from the current page:

<flux:field.relation name="settings.content"
table="tt_content" condition="AND tt_content.pid = ###THIS_UID###" />

A list of allowed markers for the condition can be found in the documentation at:

https://docs.typo3.org/typo3cms/TCAReference/ColumnsConfig/Type/Select.html#foreign-table-where

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Required
true
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box - this field on the foreign_table usually has the type "select" and also has a foreign_table defined.

foreignSortby

DataType
string
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Default
array ()
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Required
false
Description
Name of the opposite field related to a proper mm relation

field.select ViewHelper <flux:field.select>

Select-type FlexForm field ViewHelper

Choosing one of two items

Items are given in CSV mode:

<flux:field.select name="settings.position" items="left,right" default="left"/>

Items with labels

If you want to display labels that are different than the values itself, use an object in items:

<flux:field.select name="settings.position"
items="{
0:{0:'On the left side',1:'left'}, 1:{0:'On the right side',1:'right'} }"

/>

You can translate those labels by putting a LLL reference in the first property:

LLL:EXT:extname/Resources/Private/Language/locallang.xlf:flux.example.fields.items.foo'

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
true
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

renderType

DataType
string
Default
'selectSingle'
Required
false
Description
Rendering type as applies in FormEngine/TCA

showIconTable

DataType
boolean
Required
false
Description
If TRUE shows the option icons as table beneath the select

field.text ViewHelper <flux:field.text>

Textarea FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

cols

DataType
mixed
Default
85
Required
false
Description
Number of columns in editor

rows

DataType
mixed
Default
10
Required
false
Description
Number of rows in editor

defaultExtras

DataType
string
Required
false
Description
DEPRECATED, IGNORED - has no function on TYPO3 8.7+. FlexForm-syntax "defaultExtras" definition, example: "richtext[*]:rte_transform[mode=ts_css]"

enableRichText

DataType
boolean
Required
false
Description
Enable the richtext editor (RTE)

renderType

DataType
string
Required
false
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

format

DataType
string
Required
false
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

richtextConfiguration

DataType
string
Required
false
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

placeholder

DataType
string
Required
false
Description
Placeholder text which vanishes if field is filled and/or field is focused

field.tree ViewHelper <flux:field.tree>

Tree (select supertype) FlexForm field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Required
true
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box - this field on the foreign_table usually has the type "select" and also has a foreign_table defined.

foreignSortby

DataType
string
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Default
array ()
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Required
false
Description
Name of the opposite field related to a proper mm relation

parentField

DataType
string
Required
true
Description
Field containing UID of parent record

allowRecursiveMode

DataType
boolean
Required
false
Description
If TRUE, the selection of a node will trigger the selection of all child nodes too (recursively)

expandAll

DataType
boolean
Required
false
Description
If TRUE, expands all branches

nonSelectableLevels

DataType
string
Required
false
Description
Comma-separated list of levels that will not be selectable, by default the root node (which is "0") cannot be selected

maxLevels

DataType
integer
Default
2
Required
false
Description
The maximal amount of levels to be rendered (can be used to stop possible recursions)

showHeader

DataType
boolean
Required
false
Description
If TRUE, displays tree header

width

DataType
integer
Default
280
Required
false
Description
Width of TreeView component

field.userFunc ViewHelper <flux:field.userFunc>

Flexform Userfunc field ViewHelper

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

userFunc

DataType
string
Required
false
Description
UserFunc to be called, example "MyExtMyVendorMySpecialClass->renderField". Ignored on TYPO3 9.5 and above - use renderType instead.

renderType

DataType
string
Required
false
Description
Render type (TCA renderType) - required on TYPO3 9.5 and above. Render type must be registered as FormEngine node type. See https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/FormEngine/Rendering/Index.html

arguments

DataType
mixed
Required
false
Description
Optional array of arguments to pass to the UserFunction building this field

field.inline.fal ViewHelper <flux:field.inline.fal>

Creates a FAL IRRE field

To get the file references, assigned with that field in a flux form, you will have to use EXT:vhs but there are two different ViewHelpers for fluidpages templates and fluidcontent elements.

Example how to get the first file reference from a fluidcontent element, for the flux field named "settings.files":

{v:content.resources.fal(field: 'settings.files')
-> v:iterator.first() -> v:variable.set(name: 'settings.files')}

And now the example how to get the first file reference from a fluidpages template, for the flux field named "settings.files":

{v:page.resources.fal(field: 'settings.files')
-> v:iterator.first() -> v:variable.set(name: 'settings.files')}

Usage warning

Due to [TYPO3 core bug #71239](https://forge.typo3.org/issues/71239), using FAL references within sections (<flux:form.section>) in content elements or within the page configuration does not work.

When choosing a file in one section element, you will see it in all sections. When choosing a file in a page configuration, it will be visible in the subpages configuration, too.

This issue will most likely not be fixed before TYPO3 8, so do not use it.

Alternatively, you could use <flux:field.file>.

Selecting and rendering an image

Selecting a single image

<flux:field.inline.fal name="settings.image" required="1" maxItems="1" minItems="1"/>

Define crop variants

<flux:field.inline.fal name="settings.slides" required="1" maxItems="10" minItems="1" cropVariants="{
default: {
title: 'Default', allowedAspectRatios: { default: { title: '1200:450', value: '2.6666666666' } }

}

}"/>

The crop configuration can now be passed to the image viewhelper:

<f:section name="Main">
<f:for each="{v:content.resources.fal(field: 'settings.slides')}" as="image" iteration="iterator">
<f:image src="{image.uid}" height="300" class="leb-pic" crop="{image.crop}" cropVariant="default"/>

</f:for>

</f:section>

Rendering the image

{v:content.resources.fal(field: 'settings.image') -> v:iterator.first() -> v:variable.set(name: 'image')} <f:image treatIdAsReference="1" src="{image.uid}" title="{image.title}" alt="{image.alternative}"/><br/>

Rendering multiple images

<f:for each="{v:content.resources.fal(field: 'settings.image')}" as="image">
<f:image treatIdAsReference="1" src="{image.uid}" title="{image.title}" alt="{image.alternative}"/><br/>

</f:for>

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
1
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
1
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Default
'sys_file_reference'
Required
false
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Default
'uid_foreign'
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Default
'uid_local'
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Default
'uid_local'
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box this field on the foreign_table usually has the type "select" and also has a "foreign_table" defined.

foreignSortby

DataType
string
Default
'sorting_foreign'
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Default
'tablenames'
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Default
'select'
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Default
array ()
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Required
false
Description
Name of the opposite field related to a proper mm relation

collapseAll

DataType
boolean
Required
false
Description
If true, all child records are shown as collapsed.

expandSingle

DataType
boolean
Required
false
Description
Show only one expanded record at any time. If a new record is expanded, all others are collapsed.

newRecordLinkAddTitle

DataType
boolean
Default
true
Required
false
Description
Add the foreign table's title to the 'Add new' link (ie. 'Add new (sometable)')

newRecordLinkPosition

DataType
string
Default
'top'
Required
false
Description
Where to show 'Add new' link. Can be 'top', 'bottom', 'both' or 'none'.

useCombination

DataType
boolean
Required
false
Description
For use on bidirectional relations using an intermediary table. In combinations, it's possible to edit '
. 'attributes and the related child record.

useSortable

DataType
boolean
Default
true
Required
false
Description
Allow manual sorting of records.

showPossibleLocalizationRecords

DataType
boolean
Required
false
Description
Show unlocalized records which are in the original language, but not yet localized.

showRemovedLocalizationRecords

DataType
boolean
Required
false
Description
Show records which were once localized but do not exist in the original language anymore.

enabledControls

DataType
mixed
Required
false
Description
Associative array with the keys 'info', 'new', 'dragdrop', 'sort', 'hide', delete' and 'localize'. '
. 'Set either one to TRUE or FALSE to show or hide it.

headerThumbnail

DataType
mixed
Required
false
Description
Associative array with header thumbnail.

foreignMatchFields

DataType
mixed
Required
false
Description
The fields and values of the child record which have to match. For FAL the field/key is "fieldname" and the value has to be defined.

foreignTypes

DataType
mixed
Required
false
Description
Overrides the "types" TCA array of the target table with this array (beware! must be specified fully in order to work!). Expects an array of arrays; indexed by type number - each array containing for example a "showitem" CSV list value of field names to be shown when inline-editing the related record.

levelLinksPosition

DataType
string
Default
'both'
Required
false
Description
Level links position.

allowedExtensions

DataType
string
Required
false
Description
Allowed File Extensions .

disallowedExtensions

DataType
string
Required
false
Description
Disallowed File Extensions .

createNewRelationLinkTitle

DataType
string
Default
'LLL:EXT:lang/locallang_core.xlf:cm.createNewRelation'
Required
false
Description
Override label of "Create new relation" button.

cropVariants

DataType
mixed
Required
false
Description
Add one or multiple crop variants for uploaded images

field.tree.category ViewHelper <flux:field.tree.category>

Tree preset for sys_category

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

default

DataType
string
Required
false
Description
Default value for this attribute

native

DataType
boolean
Required
false
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 TYPO3CMSCoreUtilityExtensionManagementUtility::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.

position

DataType
string
Required
false
Description
Only applies if native=1. Specify where in the editing form this field should be, using the syntax of TYPO3CMSCoreUtilityExtensionManagementUtility::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"

required

DataType
boolean
Required
false
Description
If TRUE, this attribute must be filled when editing the FCE

exclude

DataType
boolean
Required
false
Description
If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this)

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

enabled

DataType
boolean
Default
true
Required
false
Description
If FALSE, disables the field in the FlexForm

requestUpdate

DataType
boolean
Required
false
Description
If TRUE, the form is force-saved and reloaded when field value changes

displayCond

DataType
string
Required
false
Description
Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond

inherit

DataType
boolean
Default
true
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Default
true
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

clear

DataType
boolean
Required
false
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

protect

DataType
boolean
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

config

DataType
mixed
Default
array ()
Required
false
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"

validate

DataType
string
Default
'trim'
Required
false
Description
FlexForm-type validation configuration for this input

size

DataType
integer
Default
10
Required
false
Description
Size of the selector box

multiple

DataType
boolean
Required
false
Description
If TRUE, allows selecting the same value multiple times

minItems

DataType
integer
Required
false
Description
Minimum required number of items to be selected

maxItems

DataType
integer
Default
30
Required
false
Description
Maxium allowed number of items to be selected

itemListStyle

DataType
string
Required
false
Description
Overrides the default list style when maxItems > 1

selectedListStyle

DataType
string
Required
false
Description
Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle

items

DataType
mixed
Required
false
Description
Items for the selector; array / CSV / Traversable / Query supported

emptyOption

DataType
mixed
Required
false
Description
If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.

translateCsvItems

DataType
boolean
Required
false
Description
If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions

itemsProcFunc

DataType
string
Required
false
Description
Function for serving items. See TCA "select" field "itemsProcFunc" attribute

table

DataType
string
Default
'sys_category'
Required
false
Description
Define foreign table name to turn selector into a record selector for that table

condition

DataType
string
Required
false
Description
Condition to use when selecting from "foreignTable", supports FlexForm foreign_table_where markers

mm

DataType
string
Default
'sys_category_record_mm'
Required
false
Description
Optional name of MM table to use for record selection

foreignField

DataType
string
Required
false
Description
The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreignLabel

DataType
string
Required
false
Description
If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the inline-view.

foreignSelector

DataType
string
Required
false
Description
A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box - this field on the foreign_table usually has the type "select" and also has a foreign_table defined.

foreignSortby

DataType
string
Required
false
Description
Field on the child record (or on the intermediate table) that stores the manual sorting information.

foreignDefaultSortby

DataType
string
Required
false
Description
If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreignTableField

DataType
string
Required
false
Description
The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is - so the child record could also be used on other parent tables.

foreignUnique

DataType
string
Required
false
Description
Field which must be uniue for all children of a parent record.

symmetricField

DataType
string
Required
false
Description
In case of bidirectional symmetric relations, this defines in which field on the foreign table the uid of the "other" parent is stored.

symmetricLabel

DataType
string
Required
false
Description
If set, this overrides the default label of the selected symmetric_field.

symmetricSortby

DataType
string
Required
false
Description
Works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored.

localizationMode

DataType
string
Required
false
Description
Set whether children can be localizable ('select') or just inherit from default language ('keep').

disableMovingChildrenWithParent

DataType
boolean
Required
false
Description
Disables that child records get moved along with their parent records.

showThumbs

DataType
boolean
Default
true
Required
false
Description
If TRUE, adds thumbnail display when editing in BE

matchFields

DataType
mixed
Required
false
Description
When using manyToMany you can provide an additional array of field=>value pairs that must match in the relation table

oppositeField

DataType
string
Default
'items'
Required
false
Description
Name of the opposite field related to a proper mm relation

parentField

DataType
string
Default
'parent'
Required
false
Description
Field containing UID of parent record

allowRecursiveMode

DataType
boolean
Required
false
Description
If TRUE, the selection of a node will trigger the selection of all child nodes too (recursively)

expandAll

DataType
boolean
Default
true
Required
false
Description
If TRUE, expands all branches

nonSelectableLevels

DataType
string
Required
false
Description
Comma-separated list of levels that will not be selectable, by default the root node (which is "0") cannot be selected

maxLevels

DataType
integer
Default
2
Required
false
Description
The maximal amount of levels to be rendered (can be used to stop possible recursions)

showHeader

DataType
boolean
Default
true
Required
false
Description
If TRUE, displays tree header

width

DataType
integer
Default
280
Required
false
Description
Width of TreeView component

form.container ViewHelper <flux:form.container>

FlexForm Field Container element

Use around other Flux fields to make these fields nested visually and in variable scopes (i.e. a field called "name" inside a palette called "person" would end up with "person" being an array containing the "name" property, rendered as {person.name} in Fluid.

The field grouping can be hidden or completely removed. In this regard this element is a simpler version of the Section and Object logic.

Grouping elements with a container

<flux:form.container name="settings.name" label="Name">
<flux:field.input name="firstname" label="First name"/> <flux:field.input name="lastname" label="Last name"/>

</flux:form.container>

Accessing values of grouped elements

Name: {settings.name.firstname} {settings.name.lastname}

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
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.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

form.content ViewHelper <flux:form.content>

Adds a content area to a source using Flux FlexForms

Only works to insert a single content area into your element. To insert multiple content areas, use instead a full flux:grid with your desired row and column structure; each column then becomes a content area.

Using flux:grid after this ViewHelper in the same flux:form will overwrite this ViewHelper.

Using this ViewHelper after flux:grid will cause this ViewHelper to be ignored.

Example of difference

<flux:form id="myform">
<!-- Creates a basic Grid with one row and one column, names
the column "mycontent" and makes Flux use this Grid -->

<flux:content name="mycontent" /> <!-- Additional flux:content tags are completely ignored -->

</flux:form>

<flux:form id="myform">
<!-- Creates a full, multi-column/row Grid --> <flux:grid> <flux:grid.row> <flux:grid.column name="mycontentA" colPos="0" /> <flux:grid.column name="mycontentB" colPos="1" /> </flux:grid.row> <flux:grid.row> <flux:grid.column name="mycontentC" colPos="2" colspan="2" /> </flux:grid.row> </flux:grid> <!-- No use of flux:content is possible after this point -->

</flux:form>

Arguments

name

DataType
string
Required
true
Description
Name of the content area, FlexForm XML-valid tag name string

label

DataType
string
Required
false
Description
Label for content area, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.columns.foobar" based on column name, in scope of extension rendering the Flux form.

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

form.data ViewHelper <flux:form.data>

Converts raw flexform xml into an associative array, and applies any transformation that may be configured for fields/objects.

Example: Fetch page configuration inside content element

Since the page variable is available in fluidcontent elements, we can use it to access page configuration data:

<flux:form.data table="pages" field="tx_fed_page_flexform" record="{page}" />

Example: Check if page is accessible before loading data

Data of disabled and deleted pages cannot be loaded with flux:form.data and lead to an TYPO3FluidFluidCoreViewHelperException. To prevent this exception, check if the page is accessible by generating a link to it:

<f:if condition="{f:uri.page(pageUid: myUid)}">
<flux:form.data table="pages" field="tx_fed_page_flexform" uid="{myUid}" as="pageSettings">
...

</flux:form.data>

</f:if>

Arguments

table

DataType
string
Required
true
Description
Name of table that contains record with Flux field

field

DataType
string
Required
true
Description
Name of Flux field in table

uid

DataType
integer
Required
false
Description
UID of record to load (used if "record" attribute not used)

record

DataType
mixed
Required
false
Description
Record containing Flux field (used if "uid" attribute not used)

as

DataType
string
Required
false
Description
Optional name of variable to assign in tag content rendering

form.object ViewHelper <flux:form.object>

FlexForm field section object ViewHelper

Use this inside flux:form.section to name and divide the fields into individual objects that can be inserted into the section.

Arguments

name

DataType
string
Required
true
Description
Name of the section object, FlexForm XML-valid tag name string

label

DataType
string
Required
false
Description
Label for section object, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.objects.foobar" based on object name, in scope of extension rendering the Flux form.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

inherit

DataType
boolean
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

transform

DataType
string
Required
false
Description
Set this to transform your value to this type - integer, array (for csv values), float, DateTime, VendorMyExtDomainModelObject or ObjectStorage with type hint.

contentContainer

DataType
boolean
Required
false
Description
If TRUE, each object that is created of this type results in a content column of the same name, with an automatic colPos value.

form.option ViewHelper <flux:form.option>

Form option ViewHelper

Arguments

value

DataType
string
Required
false
Description
Option value

name

DataType
string
Required
true
Description
Name of the option to be set

form.render ViewHelper <flux:form.render>

## Main form rendering ViewHelper

Use to render a Flux form as HTML.

Arguments

form

DataType
mixed
Required
true
Description
Form instance to render as HTML

form.section ViewHelper <flux:form.section>

FlexForm field section ViewHelper

Using a section to let a user add many elements

<flux:form.section name="settings.numbers" label="Telephone numbers">
<flux:form.object name="mobile" label="Mobile">
<flux:field.input name="number"/>

</flux:form.object> <flux:form.object name="landline" label="Landline"> <flux:field.input name="number"/> </flux:form.object>

</flux:form.section>

Reading section element values

<f:for each="{settings.numbers}" as="obj" key="id">
Number #{id}: <f:if condition="{obj.landline}">mobile, {obj.landline.number}</f:if> <f:if condition="{obj.mobile}">landline, {obj.mobile.number}</f:if> <br/>

</f:for>

Arguments

name

DataType
string
Required
true
Description
Name of the attribute, FlexForm XML-valid tag name string

label

DataType
string
Required
false
Description
Label for section, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.sections.foobar" based on section name, in scope of extension rendering the form.

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

inherit

DataType
boolean
Required
false
Description
If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider

inheritEmpty

DataType
boolean
Required
false
Description
If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider

gridMode

DataType
string
Default
'rows'
Required
false
Description
Defines how section objects which are marked as content containers, get rendered as a grid. Valid values are either "rows" or "columns". Default is to render as rows.

form.sheet ViewHelper <flux:form.sheet>

FlexForm sheet ViewHelper

Groups FlexForm fields into sheets.

Arguments

name

DataType
string
Required
true
Description
Name of the group, used as FlexForm sheet name, must be FlexForm XML-valid tag name string

label

DataType
string
Required
false
Description
Label for the field group - used as tab name in FlexForm. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.sheets.foobar" based on sheet name, in scope of extension rendering the Flux form.

variables

DataType
mixed
Default
array ()
Required
false
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

description

DataType
string
Required
false
Description
Optional string or LLL reference with a desription of the purpose of the sheet

shortDescription

DataType
string
Required
false
Description
Optional shorter version of description of purpose of the sheet, LLL reference supported

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

form.variable ViewHelper <flux:form.variable>

Sets an option in the Form instance

Arguments

value

DataType
mixed
Required
false
Description
Value of the option

name

DataType
string
Required
true
Description
Name of the option - valid values and their behaviours depend entirely on the consumer that will handle the Form instance

form.object.columnPosition ViewHelper <flux:form.object.columnPosition>

Section object - automatic colPos field

Provides a field to designate the "colPos" value of a section object, which is automatically maintained and guaranteed uniqueness when editing the backend form. Adding this field inside <flux:field.object /> renders a field that's not user editable which contains a unique colPos value for each section object.

The colPos field is then associated with the section object _and will not change even if the section object is moved up or down in the section.

This property can then be used in <flux:grid.column /> arguments if the grid columns are created by iterating the section objects and creating a column for each.

Example

<flux:form id="sectionobjectasgrid" options="{static: 1}" extensionName="FluidTYPO3.TestProviderExtension">
<flux:form.sheet name="options">
<flux:form.section name="columns">
<flux:form.object name="column" label="Column">
<flux:form.object.columnPosition />

</flux:form.object>

</flux:form.section>

</flux:form.sheet>

</flux:form> <flux:grid> <flux:grid.row> <f:for each="{columns}" as="columnObject"> <flux:grid.column colPos="{columnObject.column.colPos}" /> </f:for> </flux:grid.row> </flux:grid>

Notes

Please be aware that dynamic grid is NOT compatible with the "static" option for <flux:form /> - this option must not be enabled; if it is, the grid will not be rendered.

Arguments

This ViewHelper has no arguments.

form.option.group ViewHelper <flux:form.option.group>

Form group option ViewHelper

Defines a logical group name for the Flux form, which can then be read by extensions supporting Flux forms. How the setting gets used is specific to the extension reading the Flux form - please consult that documentation to learn if/how the extension supports this option.

Arguments

value

DataType
string
Required
false
Description
Name of the group

form.option.icon ViewHelper <flux:form.option.icon>

Icon option

Sets the icon option in the Flux form, which can then be read by extensions using Flux forms. Consult the documentation of extensions which use the icon setting to learn more about how icons are used.

value needs to be the absolute path to the image file, e.g. /typo3conf/ext/myext/Resources/Public/Icons/Element.svg.

Example

<flux:form.option.icon value="/typo3conf/ext/myext/Resources/Public/Icons/Element.svg"/>

Arguments

value

DataType
string
Required
false
Description
Path and name of the icon file

form.option.inheritanceMode ViewHelper <flux:form.option.inheritanceMode>

Inheritance mode option

Control how this Form will handle inheritance (page context only). There are two possible values of this option:

  • restricted
  • unrestricted

Note that the default (the mode which is used if you do NOT specify the mode with this ViewHelper/option) is defined by the Flux extension configuration. If you do not change the extension configuration then the default behavior is "restricted". Any template that wants to use a mode other than the default MUST specify the mode with this option.

When the option is set to "restricted" either by this ViewHelper or by extension configuration, the inheritance behavior matches the Flux behavior pre version 10.1.x, meaning that inheritance will only happen if the parent (page) has selected the same Form (layout) as the current page. As soon as a different Form is encountered in a parent, the inheritance stops. In short: inheritance only works for identical Forms.

Alternatively, when the option is set to "unrestricted", the above constraint is removed and inheritance can happen for Forms which are NOT the same.

This makes sense to use if you have different page templates which use the same values (for example a shared set of fields) and you want child pages to be able to inherit these values from parents even if the child page has selected a different page layout.

Example

<flux:form.option.inheritanceMode value="unrestricted" /> (which is the same as:) <flux:form.option.inheritanceMode>unrestricted</flux:form.option.inheritanceMode>

Or:

<flux:form.option.inheritanceMode value="restricted" /> (which is the same as:) <flux:form.option.inheritanceMode>restricted</flux:form.option.inheritanceMode>

Arguments

value

DataType
string
Required
false
Description
Mode of inheritance, either "restricted" or "unrestricted".

form.option.sorting ViewHelper <flux:form.option.sorting>

Form sorting option ViewHelper

Arguments

value

DataType
integer
Required
false
Description
Sorting value of form (how this is applied depends on the implementation using the Form instance; see third-party feature documentation)

form.option.static ViewHelper <flux:form.option.static>

Form static caching option ViewHelper

Use this only when your Flux form is 100% static and will work when cached.

Arguments

value

DataType
boolean
Default
true
Required
false
Description
Configures caching of the DS resulting from the form. Default when used is TRUE which enables caching

grid.column ViewHelper <flux:grid.column>

Flexform Grid Column ViewHelper

Used inside <flux:grid.row> tags.

Use the colPos attribute for grids in page and content elements.

See <flux:grid> for an example.

Limit allowed elements

It is possible to limit the elements allowed in the column by setting the allowedContentTypes variable:

<flux:grid.column name="elements" colPos="0">
<flux:form.variable name="allowedContentTypes" value="text,shortcut"/>

</flux:grid.column>

The value is a comma-separated list of content type IDs; they can be found in tt_content.CType column.

Limit allowed fluid content elements

It is also possible to limit the allowed fluid content elements:

<flux:grid.column name="elements" colPos="0">
<flux:form.variable name="allowedContentTypes" value="extkey_vehicledetailssectionusedcarseal"/>

</flux:grid.column>

Arguments

name

DataType
string
Default
'column'
Required
false
Description
Identifies your column and is used to fetch translations from XLF for example.

label

DataType
string
Required
false
Description
Optional column label, will be shown as column header.

colPos

DataType
integer
Required
true
Description
Column number - between 0 and 99, should be unique.

colspan

DataType
integer
Default
1
Required
false
Description
Column span

rowspan

DataType
integer
Default
1
Required
false
Description
Row span

style

DataType
string
Required
false
Description
Inline style to add when rendering the column

variables

DataType
mixed
Default
array ()
Required
false
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. Can also be set and/or overridden in tag content using <flux:form.variable />

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

grid.row ViewHelper <flux:grid.row>

Flexform Grid Row ViewHelper

Used inside <flux:grid> tags. Usually contains <flux:grid.column> tags.

See <flux:grid> for an example.

Arguments

name

DataType
string
Default
'row'
Required
false
Description
Optional name of this row - defaults to "row"

label

DataType
string
Required
false
Description
Optional label for this row - defaults to an LLL value (reported if it is missing)

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

outlet.argument

ViewHelper to define Outlet arguments

Use <flux:outlet.argument> in conjunction with the <flux:outlet> and <flux.outlet.validate> viewHelpers. You can define any number of arguments including validations that will be applied to the outlet action. To call the outlet action use the action "outlet" in your form action.

Example

<f:section name="Configuration">
<flux:outlet>
<flux:outlet.argument name="name">
<flux:outlet.validate type="NotEmpty" />

</flux:outlet.argument>

</flux:outlet>

</f:section>

<f:section name="Main">
<f:form action="outlet" noCache="1">
<f:form.textfield name="name" value="{name}" />

</f:form>

</f:section>

Arguments

name

DataType
string
Required
false
Description
Name of the argument

type

DataType
string
Default
'string'
Required
false
Description
Type of the argument

outlet.form

Outlet Form Renderer

Specialised version of f:form which adds three vital behaviors:

  • Automatic resolving of the correct extension name and plugin name
  • Automatic use of "outletAction" on controller
  • Addition of table name and UID as to prevent calling "outletAction" on any other instance than the one which rendered the form.

Together these specialised behaviors mean that the form data will only be processed by the exact instance from which the form was rendered, and will always target the correct plugin namespace for the arguments to be recognised.

To customise handling of this form, add an "outletAction" to your Flux controller with which your template is associated, e.g. your "ContentController", "PageController" etc.

Arguments

additionalAttributes

DataType
mixed
Required
false
Description
Additional tag attributes. They will be added directly to the resulting HTML tag.

data

DataType
mixed
Required
false
Description
Additional data-* attributes. They will each be added with a "data-" prefix.

aria

DataType
mixed
Required
false
Description
Additional aria-* attributes. They will each be added with a "aria-" prefix.

action

DataType
string
Required
false
Description
Target action

arguments

DataType
mixed
Default
array ()
Required
false
Description
Arguments

controller

DataType
string
Required
false
Description
Target controller

extensionName

DataType
string
Required
false
Description
Target Extension Name (without tx_ prefix and no underscores). If NULL the current extension name is used

pluginName

DataType
string
Required
false
Description
Target plugin. If empty, the current plugin name is used

pageUid

DataType
mixed
Required
false
Description
Target page uid

object

DataType
mixed
Required
false
Description
Object to use for the form. Use in conjunction with the "property" attribute on the sub tags

pageType

DataType
mixed
Required
false
Description
Target page type

noCache

DataType
mixed
Required
false
Description
Set this to disable caching for the target page. You should not need this.

section

DataType
string
Required
false
Description
The anchor to be added to the action URI (only active if $actionUri is not set)

format

DataType
string
Required
false
Description
The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)

additionalParams

DataType
mixed
Default
array ()
Required
false
Description
Additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)

absolute

DataType
mixed
Required
false
Description
If set, an absolute action URI is rendered (only active if $actionUri is not set)

addQueryString

DataType
mixed
Required
false
Description
If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)

argumentsToBeExcludedFromQueryString

DataType
mixed
Default
array ()
Required
false
Description
Arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set

addQueryStringMethod

DataType
string
Required
false
Description
This argument is not evaluated anymore and will be removed in TYPO3 v12.

fieldNamePrefix

DataType
string
Required
false
Description
Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin

actionUri

DataType
string
Required
false
Description
Can be used to overwrite the "action" attribute of the form tag

objectName

DataType
string
Required
false
Description
Name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName

hiddenFieldClassName

DataType
string
Required
false
Description
HiddenFieldClassName

enctype

DataType
string
Required
false
Description
MIME type with which the form is submitted

method

DataType
string
Required
false
Description
Transfer type (GET or POST)

name

DataType
string
Required
false
Description
Name of form

onreset

DataType
string
Required
false
Description
JavaScript: On reset of the form

onsubmit

DataType
string
Required
false
Description
JavaScript: On submit of the form

target

DataType
string
Required
false
Description
Target attribute of the form

novalidate

DataType
mixed
Required
false
Description
Indicate that the form is not to be validated on submit.

class

DataType
string
Required
false
Description
CSS class(es) for this element

dir

DataType
string
Required
false
Description
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id

DataType
string
Required
false
Description
Unique (in this file) identifier for this HTML element.

lang

DataType
string
Required
false
Description
Language for this element. Use short names specified in RFC 1766

style

DataType
string
Required
false
Description
Individual CSS styles for this element

title

DataType
string
Required
false
Description
Tooltip text of element

accesskey

DataType
string
Required
false
Description
Keyboard shortcut to access this element

tabindex

DataType
integer
Required
false
Description
Specifies the tab order of this element

onclick

DataType
string
Required
false
Description
JavaScript evaluated for the onclick event

outlet.validate

ViewHelper to validate Outlet arguments

Use <flux:outlet.validate> inside the <flux.outlet.argument> viewHelper. You can add any number of validations to the arguments. After submission validation errors will be available inside the validationResults variable.

Example

<f:section name="Configuration">
<flux:outlet>
<flux:outlet.argument name="name">
<flux:outlet.validate type="NotEmpty" />

</flux:outlet.argument>

</flux:outlet>

</f:section>

<f:section name="Main">
<f:form noCache="1">
<f:form.textfield name="name" value="{name}" /> <f:if condition="{validationResults.name}"> <f:for each="{validationResults.name}" as="error"> <span class="error">{error.code}: {error.message}</span> </f:for> </f:if>

</f:form>

</f:section>

Arguments

type

DataType
string
Required
false
Description
Validator to apply

options

DataType
mixed
Required
false
Description
Additional validator arguments

pipe.controller

Controller Action Outlet Pipe ViewHelper

Adds a ControllerPipe to the Form's Outlet.

Arguments

direction

DataType
string
Default
'out'
Required
false
Description
Which endpoint to attach the Pipe to - either "in" or "out". See documentation about Outlets and Pipes

action

DataType
string
Required
false
Description
Action to call on the controller, minus the "Action" suffix

controller

DataType
string
Required
false
Description
Class name of controller to call. If empty, uses current controller

extensionName

DataType
string
Required
false
Description
Extension name of controller to call. If empty, uses current extension name

pipe.email

Email Outlet Pipe ViewHelper

Adds an EmailPipe to the Form's Outlet

Arguments

direction

DataType
string
Default
'out'
Required
false
Description
Which endpoint to attach the Pipe to - either "in" or "out". See documentation about Outlets and Pipes

body

DataType
string
Required
false
Description
Message body. Can also be inserted as tag content

bodySection

DataType
string
Required
false
Description
Section to use for the body

subject

DataType
string
Required
false
Description
Message subject

recipient

DataType
string
Required
false
Description
Message recipient address or name+address as "Name <add@ress>"

sender

DataType
string
Required
false
Description
Message sender address or name+address as "Name <add@ress>"

pipe.flashMessage

FlashMessage Outlet Pipe ViewHelper

Adds a FlashMessagePipe to the Form's Outlet

Arguments

direction

DataType
string
Default
'out'
Required
false
Description
Which endpoint to attach the Pipe to - either "in" or "out". See documentation about Outlets and Pipes

message

DataType
string
Required
false
Description
FlashMessage message body

title

DataType
string
Default
'Message'
Required
false
Description
FlashMessage title to use

severity

DataType
integer
Required
false
Description
Severity level, as integer

storeInSession

DataType
boolean
Default
true
Required
false
Description
Store message in sesssion. If FALSE, message only lives in POST. Default TRUE.

pipe.typeConverter

Type Converter Outlet Pipe ViewHelper

Adds a TypeConverterPipe to the Form's Outlet.

Arguments

direction

DataType
string
Default
'out'
Required
false
Description
Which endpoint to attach the Pipe to - either "in" or "out". See documentation about Outlets and Pipes

targetType

DataType
string
Required
false
Description
Target type (class name, integer, array, etc.)

typeConverter

DataType
mixed
Required
false
Description
Class or instance of type converter. Can be a short name of a system type converter, minus "Converter" suffix, e.g. PersistentObject, Array etc.

property

DataType
string
Required
false
Description
Optional property which needs to be converted in data. If empty, uses entire form data array as input.

wizard.add

Field Wizard: Add

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Default
'Add new record'
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

table

DataType
string
Required
false
Description
Table name that records are added to

pid

DataType
mixed
Default
'###CURRENT_PID###'
Required
false
Description
Storage page UID or (as is default) ###CURRENT_PID###

setValue

DataType
string
Default
'prepend'
Required
false
Description
How to treat the record once created

wizard.colorPicker

Field Wizard: Color Picker

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Default
'Choose color'
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

dim

DataType
string
Default
'20x20'
Required
false
Description
Dimensions (WxH, e.g. 20x20) of color picker

width

DataType
integer
Default
450
Required
false
Description
Width of the popup window

height

DataType
integer
Default
720
Required
false
Description
Height of the popup window

exampleImg

DataType
string
Default
'EXT:flux/Resources/Public/Icons/ColorWheel.png'
Required
false
Description
Example image from which to pick colors

wizard.edit

Field Wizard: Edit

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

width

DataType
integer
Default
580
Required
false
Description
Width of the popup window

height

DataType
integer
Default
580
Required
false
Description
Height of the popup window

openOnlyIfSelected

DataType
boolean
Default
true
Required
false
Description
Only open the edit dialog if an item is selected

wizard.list

Field Wizard: List

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

table

DataType
string
Required
false
Description
Table name that records are added to

pid

DataType
mixed
Default
'###CURRENT_PID###'
Required
false
Description
Storage page UID or (as is default) ###CURRENT_PID###

width

DataType
integer
Default
500
Required
false
Description
Width of the popup window

height

DataType
integer
Default
500
Required
false
Description
Height of the popup window

wizard.select

Field Wizard: Edit

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

mode

DataType
string
Default
'substitution'
Required
false
Description
Selection mode - substitution, append or prepend

items

DataType
mixed
Required
false
Description
Comma-separated, comma-and-semicolon-separated or array list of possible values

wizard.slider

Field Wizard: Slider

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Default
'Slider'
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

step

DataType
integer
Default
1
Required
false
Description
Increment slider values by this much for each step

width

DataType
integer
Default
32
Required
false
Description
Width of the popup window

wizard.suggest

Field Wizard: Suggest

See https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/CoreWizardScripts/Index.html for details about the behaviors that are controlled by arguments.

DEPRECATED - use flux:field with custom "config" with renderMode and/or fieldWizard attributes

Arguments

label

DataType
string
Required
false
Description
Optional title of this Wizard

hideParent

DataType
boolean
Required
false
Description
If TRUE, hides the parent field

variables

DataType
mixed
Default
array ()
Required
false
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

extensionName

DataType
string
Required
false
Description
If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

table

DataType
string
Required
false
Description
Table to search. If left out will use the table defined by the parent field

pidList

DataType
string
Required
false
Description
List of storage page UIDs

pidDepth

DataType
integer
Default
99
Required
false
Description
Depth of recursive storage page UID lookups

minimumCharacters

DataType
integer
Default
1
Required
false
Description
Minimum number of characters that must be typed before search begins

maxPathTitleLength

DataType
integer
Default
15
Required
false
Description
Maximum path segment length - crops titles over this length

searchWholePhrase

DataType
boolean
Required
false
Description
A match requires a full word that matches the search value

searchCondition

DataType
string
Required
false
Description
Search condition - for example, if table is pages "doktype = 1" to only allow standard pages

cssClass

DataType
string
Required
false
Description
Use this CSS class for all list items

receiverClass

DataType
string
Required
false
Description
Class reference, target class should be derived from "t3lib_tceforms_suggest_defaultreceiver"

renderFunc

DataType
string
Required
false
Description
Reference to function which processes all records displayed in results

Changelog

Please follow these links to find out which feature has been implemented or which bug has been fixed in which version.

List of versions

Sitemap

Index

outlet

ViewHelper to configure outlets

see <flux:outlet.argument> and <flux:outlet.validate> ViewHelpers for more information

Arguments

enabled

DataType
boolean
Default
true
Required
false
Description
If the outlet is enabled