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