Select¶
type => 'select' // TCA
The Select
type generates a simple select field.
Settings¶
-
renderType
¶ -
- Required
-
yes
- Type
-
string
selectSingle
selectCheckBox
selectSingleBox
selectTree
selectMultipleSideBySide
-
items
¶ -
- Required
-
false
- Type
-
array
Contains the elements for the selector box. Each item is an array. An item consists of a
label
and avalue
.Example:
items: - label: 'The first' value: one - label: 'The second' value: two - label: 'The third' value: three
Copied!Tip
You can omit the label, if you have the translation already in your Labels.xlf file.
items: - value: one - value: two - value: three
Copied!XLF translation keys for items have the following convention:
<body> <trans-unit id="FIELD_IDENTIFIER.items.one.label"> <source>Label for item with value one</source> </trans-unit> <trans-unit id="FIELD_IDENTIFIER.items.two.label"> <source>Label for item with value two</source> </trans-unit> <trans-unit id="FIELD_IDENTIFIER.items.VALUE.label"> <source>Label for item with value VALUE</source> </trans-unit> <trans-unit id="FIELD_IDENTIFIER.items.label"> <source>Label for item with empty value</source> </trans-unit> </body>
Copied!
-
default
¶ -
- Required
-
false
- Type
-
string
Default value set if a new record is created.
-
maxitems
¶ -
- Required
-
false
- Type
-
integer
Maximum number of child items. Defaults to a high value. JavaScript record validation prevents the record from being saved if the limit is not satisfied. If
maxitems
ist set to greater than 1, multiselect is automatically enabled.
-
minitems
¶ -
- Required
-
false
- Type
-
integer
Minimum number of child items. Defaults to 0. JavaScript record validation prevents the record from being saved if the limit is not satisfied. The field can be set as required by setting
minitems
to at least 1.
-
allowedCustomProperties
¶ -
- Required
-
false
- Type
-
array
- Default
-
["itemsProcConfig"]
Sometimes it is needed to provide custom configuration for the itemsProcFunc functionality. These extra properties need to be explicitly allowed via this option. This option receives an array of those strings. By default, the custom option
itemsProcConfig
is allowed.
For more advanced configuration refer to the TCA documentation.
Example¶
Minimal¶
Select single:
name: example/select
fields:
- identifier: select
type: Select
renderType: selectSingle
items:
- label: 'The first'
value: one
- label: 'The second'
value: two
Select multiple:
name: example/select
fields:
- identifier: select_side_by_side
type: Select
renderType: selectMultipleSideBySide
items:
- label: 'The first'
value: one
- label: 'The second'
value: two
Advanced / use case¶
Select single:
name: example/select
fields:
- identifier: select
type: Select
renderType: selectSingle
default: 'one'
minitems: 1
maxitems: 3
items:
- label: 'The first'
value: one
- label: 'The second'
value: two
- label: 'The third'
value: three
foreign_table: pages
foreign_table_where: 'AND {#pages}.{#pid} = 123 ORDER BY uid'
Select multiple:
name: example/select
fields:
- identifier: select_side_by_side
type: Select
renderType: selectMultipleSideBySide
default: 'one'
minitems: 1
maxitems: 3
items:
- label: 'The first'
value: one
- label: 'The second'
value: two
- label: 'The third'
value: three
foreign_table: pages
foreign_table_where: 'AND {#pages}.{#pid} = 123 ORDER BY uid'
Select tree:
name: example/select
fields:
- identifier: select_tree
type: Select
renderType: selectTree
size: 5
foreign_table: 'pages'
foreign_table_where: 'ORDER BY pages.uid'
treeConfig:
parentField: pid