[TASK] Cleanup TCA select field configuration
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Deprecation-69822-DeprecateSelectFieldTca.rst
1 =============================================================
2 Deprecation: #69822 - Deprecate TCA settings of select fields
3 =============================================================
4
5 Description
6 ===========
7
8 Using the TCA field type ``select`` without specifying a valid ``renderType`` is deprecated.
9
10 Additionally the usage of ``renderMode`` for select fields is deprecated.
11
12 These ``renderType`` settings are available:
13
14
15 .. container:: table-row
16
17    Key
18          renderType
19
20    Datatype
21          string
22
23    Description
24         This setting specifies how the select field should be displayed. Available options are:
25
26         - ``selectSingle`` - Normal select field for selecting a single value.
27         - ``selectSingleBox`` - Normal select field for selecting multiple values.
28         - ``selectCheckBox`` - List of checkboxes for selecting muliple values.
29         - ``selectMultipleSideBySide`` - Two select fields, items can be selected from the right
30           field, selected items are displayed in the left select.
31         - ``selectTree`` - A tree for selecting hierarchical data.
32
33    Scope
34          Display
35
36
37 'renderType' => 'selectMultipleSideBySide',
38 'renderType' => 'selectCheckBox',
39 'renderType' => 'selectSingle',
40 'renderType' => 'selectSingleBox',
41 'renderType' => 'selectTree',
42
43 .. note::
44
45             If a field has no ``renderType`` set but ``maxitems`` is set, the migration will set
46             ``renderType`` to ``selectSingle`` in case of ``maxitems`` is <= 1 otherwise ``renderType``
47             is set to ``selectMultipleSideBySide``
48
49
50 Impact
51 ======
52
53 The old TCA settings can still be used. A migration handles the update of the settings.
54
55
56 Affected Installations
57 ======================
58
59 All installations with extensions that configure TCA select fields in the old format.
60
61
62 Migration
63 =========
64
65 Extension authors need to add the correct ``renderType`` setting to their select
66 field definitions.