b6033ea3fc33c35755360c9db36f76c021dac623
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / 9.2 / Feature-83556-AddToggleSwitchesToFormEngine.rst
1 .. include:: ../../Includes.txt
2
3 ===================================================
4 Feature: #83556 - Add toggle switches to FormEngine
5 ===================================================
6
7 See :issue:`83556`
8
9 Description
10 ===========
11
12 In order to give FormEngine a fresher look we add the following `renderTypes` to `type=checkbox`.
13
14 renderType checkboxToggle
15 =========================
16
17 A pure toggle switch. No additional configuration is necessary.
18
19 Its state can be inverted via `invertStateDisplay`.
20
21
22 renderType checkboxLabeledToggle
23 ================================
24
25 A toggle switch where both states can be labelled (ON/OFF, Visible / Hidden or alike).
26
27 Its state can be inverted via `invertStateDisplay`
28
29 .. code-block:: php
30
31    'items' => [
32       [
33          0 => 'foo',
34          1 => '',
35          'labelChecked' => 'Enabled',
36          'labelUnchecked' => 'Disabled',
37          'invertStateDisplay' => false
38       ]
39    ]
40
41
42 renderType default
43 =============================
44
45 A toggle that toggles between two icon identifiers.
46
47 By default the toggle icons are visually designed to mimic a checkbox.
48
49 Its state can be inverted via `invertStateDisplay`.
50
51 .. code-block:: php
52
53    'items' => [
54       [
55          0 => 'foo',
56          1 => '',
57          'iconIdentifierChecked' => 'styleguide-icon-toggle-checked',
58          'iconIdentifierUnchecked' => 'styleguide-icon-toggle-checked',
59          'invertStateDisplay' => false
60       ]
61    ]
62
63 .. index:: Backend, PHP-API, TCA