[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Administration / WizardSettings / DefaultsReference / ElementsTab / Index.rst
1 .. include:: ../../../../Includes.txt
2
3
4 .. _wizard-settings-defaults-elements-tab:
5
6 ==============
7 Tab "Elements"
8 ==============
9
10 The elements tab contains an accordion with buttons, grouped by their
11 type. These buttons identify a form element, like a text field, password
12 field or submit button. When dragging a button to the form on the right
13 and dropping it at a certain point in the form, the element will be added
14 to the form at that point. An editor can also double click a button. When
15 doing so, the element will be added at the end of the form.
16
17 .. figure:: ../../../../Images/FormCreationWizardElementsTab.png
18     :alt: The form wizard with the tab "Elements".
19
20 .. contents::
21     :local:
22     :depth: 1
23
24
25 .. _wizard-settings-defaults-elements-showaccordions:
26
27 showAccordions
28 ==============
29
30 (:ts:`mod.wizards.form.defaults.tabs.elements.showAccordions`)
31
32 :aspect:`Property:`
33     showAccordions
34
35 :aspect:`Data type:`
36     string
37
38 :aspect:`Description:`
39     Comma-separated list of the accordions that will be shown in the
40     wizard. Each of the three accordions contain a single showButton
41     property which defines which form elements will be shown in a given
42     accordion.
43
44 :aspect:`Default:`
45     basic, predefined, content
46
47
48 .. _wizard-settings-defaults-elements-accordions-showbuttons:
49
50 showButtons
51 ===========
52
53 (:ts:`mod.wizards.form.defaults.tabs.elements.accordions.[NameOfAccordion].showButtons`)
54
55 :aspect:`Property:`
56     showButtons
57
58 :aspect:`Data type:`
59     string
60
61 :aspect:`Description:`
62     Comma-separated list of the buttons that will be shown in the accordion.
63     Please note, in the shown path has [NameOfAccordion] to be replaced with
64     the name of the specific accordion.
65
66 :aspect:`Default:`
67     **"basic" elements**
68
69     - textline (Text Field)
70     - textarea (Textarea)
71     - checkbox (Checkbox)
72     - radio (Radio Button)
73     - select (Drop Down)
74     - fileupload (Upload Field)
75     - hidden (Hidden Field)
76     - password (Password Field)
77     - fieldset (Fieldset)
78     - submit (Submit Button)
79     - reset (Reset Button)
80     - button (Button)
81
82     |
83
84     **"predefined" elements**
85
86     - name (Full Name)
87     - email (Email)
88     - checkboxgroup (Checkbox Group)
89     - radiogroup (Radio Button Group)
90
91     |
92
93     **"content" elements**
94
95     - header (Header)
96     - textblock (Text Block)
97
98
99 .. _wizard-settings-defaults-elements-tab-configuration:
100
101 Default configuration
102 =====================
103
104 The default configuration of the elements tab is as follows.
105
106 .. code-block:: typoscript
107
108   mod.wizards {
109     form {
110       defaults {
111         showTabs = elements, options, form
112         tabs {
113           elements {
114             showAccordions = basic, predefined, content
115             accordions {
116               basic {
117                 showButtons = textline, textarea, checkbox, radio, select, fileupload, hidden, password, fieldset, submit, reset, button
118               }
119               predefined {
120                 showButtons = name, email, checkboxgroup, radiogroup
121               }
122               content {
123                 showButtons = header, textblock
124               }
125             }
126           }
127         }
128       }
129     }
130   }
131