[TASK] Document 'defaultValue' handling of form
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Config / proto / formElements / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition:
5
6 ========================
7 [formElementsDefinition]
8 ========================
9
10
11 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition-properties:
12
13 Properties
14 ==========
15
16 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.*:
17
18 [formElementsDefinition]
19 ------------------------
20
21 :aspect:`Option path`
22       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition
23
24 :aspect:`Data type`
25       array
26
27 :aspect:`Needed by`
28       Frontend/ Backend (form editor)
29
30 :aspect:`Mandatory`
31       Yes
32
33 :aspect:`Default value`
34       .. code-block:: yaml
35          :linenos:
36
37          prototypes:
38            <prototypeIdentifier>:
39              formElementsDefinition:
40                [...]
41
42 :aspect:`Good to know`
43       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
44
45 :aspect:`Description`
46       Array which defines the available form elements. Every key within this array is called the ``<formElementTypeIdentifier>``.
47
48
49 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>:
50
51 <formElementTypeIdentifier>
52 ---------------------------
53
54 :aspect:`Option path`
55       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>
56
57 :aspect:`Data type`
58       string
59
60 :aspect:`Needed by`
61       Frontend/ Backend (form editor)
62
63 :aspect:`Mandatory`
64       Yes
65
66 :aspect:`Default value (for prototype 'standard')`
67       .. code-block:: yaml
68          :linenos:
69
70          prototypes:
71            standard:
72              Form:
73                [...]
74              Page:
75                [...]
76              SummaryPage:
77                [...]
78              Fieldset:
79                [...]
80              GridContainer:
81                [...]
82              GridRow:
83                [...]
84              Text:
85                [...]
86              Password:
87                [...]
88              AdvancedPassword:
89                [...]
90              Textarea:
91                [...]
92              Honeypot:
93                [...]
94              Hidden:
95                [...]
96              Checkbox:
97                [...]
98              MultiCheckbox:
99                [...]
100              MultiSelect:
101                [...]
102              RadioButton:
103                [...]
104              SingleSelect:
105                [...]
106              DatePicker:
107                [...]
108              StaticText:
109                [...]
110              ContentElement:
111                [...]
112              FileUpload:
113                [...]
114              ImageUpload:
115                [...]
116
117 :aspect:`Good to know`
118       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
119
120 :aspect:`Description`
121       This array key identifies a form element. This identifier could be used to attach a form element to a form.
122
123
124 .. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-commonproperties:
125
126 Common <formElementTypeIdentifier> properties
127 =============================================
128
129
130 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.defaultValue:
131
132 defaultValue
133 ------------
134
135 :aspect:`Option path`
136       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.defaultValue
137
138 :aspect:`Data type`
139       string/ array
140
141 :aspect:`Needed by`
142       Frontend/ Backend (form editor)
143
144 :aspect:`Mandatory`
145       No
146
147 :aspect:`Default value`
148       undefined
149
150 :aspect:`Description`
151       If set this string/ array will be used as default value of the form
152       element. Array is in place for multi value elements (e.g. the
153       ``MultiSelect`` form element).
154
155
156 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.implementationclassname:
157
158 implementationClassName
159 -----------------------
160
161 :aspect:`Option path`
162       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.implementationClassName
163
164 :aspect:`Data type`
165       string
166
167 :aspect:`Needed by`
168       Frontend/ Backend (form editor)
169
170 :aspect:`Mandatory`
171       Yes
172
173 :aspect:`Default value`
174       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
175
176 :aspect:`Good to know`
177       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
178
179 :aspect:`Description`
180       Classname which implements the form element.
181
182
183 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.translation.translationfile:
184
185 renderingOptions.translation.translationFile
186 --------------------------------------------
187
188 :aspect:`Option path`
189       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.translation.translationFile
190
191 :aspect:`Data type`
192       string/ array
193
194 :aspect:`Needed by`
195       Frontend/ Backend (form editor)
196
197 :aspect:`Mandatory`
198       No
199
200 :aspect:`Default value`
201       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
202
203 :aspect:`Good to know`
204       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
205       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
206
207 :aspect:`Description`
208       Filesystem path(s) to translation files which should be searched for form element property translations.
209       If ``translationFile`` is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used.
210
211
212 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingOptions.translation.translatePropertyValueIfEmpty:
213
214 renderingOptions.translation.translatePropertyValueIfEmpty
215 ----------------------------------------------------------
216
217 :aspect:`Option path`
218       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingoptions.translation.translatepropertyvalueifempty
219
220 :aspect:`Data type`
221       bool
222
223 :aspect:`Needed by`
224       Frontend/ Backend (form editor)
225
226 :aspect:`Mandatory`
227       No
228
229 :aspect:`Default value`
230       true
231
232 :aspect:`Good to know`
233       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
234       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
235
236 :aspect:`Description`
237       If set to ``false``, the form element property translation will be skipped if the form element property value is empty.
238
239
240 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.templatename:
241
242 renderingOptions.templateName
243 -----------------------------
244
245 :aspect:`Option path`
246       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.templateName
247
248 :aspect:`Data type`
249       string
250
251 :aspect:`Needed by`
252       Frontend/ Backend (form editor)
253
254 :aspect:`Mandatory`
255       (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
256
257 :aspect:`Default value`
258       undefined
259
260 :aspect:`Good to know`
261       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
262       - :ref:`"templateName"<apireference-frontendrendering-fluidformrenderer-options-templatename>`
263
264 :aspect:`Description`
265       Set ``templateName`` to define a custom template name which should be used instead of the ``<formElementTypeIdentifier>``.
266
267
268 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties:
269
270 properties
271 ----------
272
273 :aspect:`Option path`
274       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties
275
276 :aspect:`Data type`
277       array
278
279 :aspect:`Needed by`
280       Frontend/ Backend (form editor)
281
282 :aspect:`Mandatory`
283       No
284
285 :aspect:`Default value`
286       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
287
288 :aspect:`Good to know`
289       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
290       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
291
292 :aspect:`Description`
293       Array with form element specific properties.
294
295
296 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.fluidadditionalattributes:
297
298 properties.fluidAdditionalAttributes
299 ------------------------------------
300
301 :aspect:`Option path`
302       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.fluidAdditionalAttributes
303
304 :aspect:`Data type`
305       array
306
307 :aspect:`Needed by`
308       Frontend/ Backend (form editor)
309
310 :aspect:`Mandatory`
311       No
312
313 :aspect:`Default value`
314       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
315
316 :aspect:`Good to know`
317       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
318       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
319
320 :aspect:`Description`
321       The values within this array goes directely into the fluid form element viewhelpers property ``additionalAttributes``.
322
323
324 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration:
325
326 properties.gridColumnClassAutoConfiguration
327 -------------------------------------------
328
329 :aspect:`Option path`
330       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration
331
332 :aspect:`Data type`
333       array
334
335 :aspect:`Needed by`
336       Frontend/ Backend (form editor)
337
338 :aspect:`Mandatory`
339       No
340
341 :aspect:`Default value`
342       Undefined
343
344 :aspect:`Related options`
345       - :ref:`"GridRow viewPorts"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.viewports>`
346
347 :aspect:`Description`
348         If the form element lies within a GridRow you can define the number of columns which the form element should occupy.
349         Each ``viewPorts`` configuration key has to match with on ofe the defined viewports within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts``
350
351               .. code-block:: yaml
352                  :linenos:
353
354                   gridColumnClassAutoConfiguration:
355                     viewPorts:
356                       lg:
357                         numbersOfColumnsToUse: '2'
358                       md:
359                         numbersOfColumnsToUse: '3'
360                       sm:
361                         numbersOfColumnsToUse: '4'
362                       xs:
363                         numbersOfColumnsToUse: '5'
364
365 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.label:
366
367 label
368 -----
369
370 :aspect:`Option path`
371       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.label
372
373 :aspect:`Data type`
374       string
375
376 :aspect:`Needed by`
377       Frontend/ Backend (form editor)
378
379 :aspect:`Mandatory`
380       No
381
382 :aspect:`Default value`
383       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
384
385 :aspect:`Good to know`
386       - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
387       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
388
389 :aspect:`Description`
390       The label for the form element.
391
392
393 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor:
394
395 formEditor
396 ----------
397
398 :aspect:`Option path`
399       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor
400
401 :aspect:`Data type`
402       array
403
404 :aspect:`Needed by`
405       Backend (form editor)
406
407 :aspect:`Mandatory`
408       No (but recommended)
409
410 :aspect:`Default value`
411       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
412
413 .. :aspect:`Good to know`
414       ToDo
415
416 :aspect:`Description`
417       Array with configurations for the ``form editor``
418
419
420 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.predefineddefaults:
421
422 formEditor.predefinedDefaults
423 -----------------------------
424
425 :aspect:`Option path`
426       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.predefinedDefaults
427
428 :aspect:`Data type`
429       array
430
431 :aspect:`Needed by`
432       Backend (form editor)
433
434 :aspect:`Mandatory`
435       Yes
436
437 :aspect:`Default value`
438       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
439
440 :aspect:`Good to know`
441       - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
442
443 :aspect:`Description`
444       Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.
445
446
447 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections:
448
449 formEditor.propertyCollections
450 ------------------------------
451
452 :aspect:`Option path`
453       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections
454
455 :aspect:`Data type`
456       array
457
458 :aspect:`Needed by`
459       Backend (form editor)
460
461 :aspect:`Mandatory`
462       No
463
464 :aspect:`Default value`
465       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
466
467 :aspect:`Good to know`
468       - :ref:`"Inspector"<concepts-formeditor-inspector>`
469
470 :aspect:`Description`
471       Array with configurations for ``property collections`` for the form element.
472
473
474 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators:
475
476 formEditor.propertyCollections.validators
477 -----------------------------------------
478
479 :aspect:`Option path`
480       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators
481
482 :aspect:`Data type`
483       array
484
485 :aspect:`Needed by`
486       Backend (form editor)
487
488 :aspect:`Mandatory`
489       No
490
491 :aspect:`Default value`
492       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
493
494 :aspect:`Good to know`
495       - :ref:`"Inspector"<concepts-formeditor-inspector>`
496
497 :aspect:`Description`
498       Array with configurations for available validators for a form element.
499
500
501 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.identifier:
502
503 formEditor.propertyCollections.validators.[*].identifier
504 --------------------------------------------------------
505
506 :aspect:`Option path`
507       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].identifier
508
509 :aspect:`Data type`
510       string
511
512 :aspect:`Needed by`
513       Backend (form editor)
514
515 :aspect:`Mandatory`
516       Yes
517
518 :aspect:`Default value`
519       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
520
521 :aspect:`Good to know`
522       - :ref:`"Inspector"<concepts-formeditor-inspector>`
523       - :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
524
525 :aspect:`Description`
526       Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
527
528
529 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.editors:
530
531 formEditor.propertyCollections.validators.[*].editors
532 -----------------------------------------------------
533
534 :aspect:`Option path`
535       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].editors
536
537 :aspect:`Data type`
538       string
539
540 :aspect:`Needed by`
541       Backend (form editor)
542
543 :aspect:`Mandatory`
544       Yes
545
546 :aspect:`Default value`
547       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
548
549 :aspect:`Good to know`
550       - :ref:`"Inspector"<concepts-formeditor-inspector>`
551
552 :aspect:`Description`
553       Array with available ``inspector editors`` for this validator.
554
555
556 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers:
557
558 formEditor.propertyCollections.finishers
559 ----------------------------------------
560
561 :aspect:`Option path`
562       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers
563
564 :aspect:`Data type`
565       array
566
567 :aspect:`Needed by`
568       Backend (form editor)
569
570 :aspect:`Mandatory`
571       No
572
573 :aspect:`Default value`
574       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
575
576 :aspect:`Good to know`
577       - :ref:`"Inspector"<concepts-formeditor-inspector>`
578
579 :aspect:`Description`
580       Array with configurations for available finisher for a form definition.
581
582
583 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.identifier:
584
585 formEditor.propertyCollections.finishers.[*].identifier
586 -------------------------------------------------------
587
588 :aspect:`Option path`
589       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier
590
591 :aspect:`Data type`
592       string
593
594 :aspect:`Needed by`
595       Backend (form editor)
596
597 :aspect:`Mandatory`
598       No
599
600 :aspect:`Default value`
601       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
602
603 :aspect:`Good to know`
604       - :ref:`"Inspector"<concepts-formeditor-inspector>`
605       - :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>`
606
607 :aspect:`Description`
608       Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``.
609
610
611 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.editors:
612
613 formEditor.propertyCollections.finishers.[*].editors
614 ----------------------------------------------------
615
616 :aspect:`Option path`
617       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].editors
618
619 :aspect:`Data type`
620       string
621
622 :aspect:`Needed by`
623       Backend (form editor)
624
625 :aspect:`Mandatory`
626       No
627
628 :aspect:`Default value`
629       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
630
631 :aspect:`Good to know`
632       - :ref:`"Inspector"<concepts-formeditor-inspector>`
633
634 :aspect:`Description`
635       Array with available ``inspector editors`` for this finisher.
636
637
638 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.label:
639
640 formEditor.label
641 ----------------
642
643 :aspect:`Option path`
644       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.label
645
646 :aspect:`Data type`
647       string
648
649 :aspect:`Needed by`
650       Backend (form editor)
651
652 :aspect:`Mandatory`
653       Yes
654
655 :aspect:`Default value`
656       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
657
658 :aspect:`Good to know`
659       - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
660
661 :aspect:`Description`
662       This label will be shown within the "new element" Modal.
663
664
665 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.group:
666
667 formEditor.group
668 ----------------
669
670 :aspect:`Option path`
671       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.group
672
673 :aspect:`Data type`
674       string
675
676 :aspect:`Needed by`
677       Backend (form editor)
678
679 :aspect:`Mandatory`
680       No
681
682 :aspect:`Related options`
683       - :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formElementGroups <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementgroups>`
684
685 :aspect:`Default value`
686       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
687
688 :aspect:`Description`
689       Define within which group within the ``form editor`` "new Element" modal the form element should be shown.
690       The ``group`` value must be equal to an array key within ``formElementGroups``.
691
692
693 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.groupsorting:
694
695 formEditor.groupSorting
696 -----------------------
697
698 :aspect:`Option path`
699       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.groupSorting
700
701 :aspect:`Data type`
702       int
703
704 :aspect:`Needed by`
705       Backend (form editor)
706
707 :aspect:`Mandatory`
708       No
709
710 :aspect:`Default value`
711       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
712
713 .. :aspect:`Good to know`
714       ToDo
715
716 :aspect:`Description`
717       The position within the ``formEditor.group`` for this form element.
718
719
720 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.iconidentifier:
721
722 formEditor.iconIdentifier
723 -------------------------
724
725 :aspect:`Option path`
726       TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.iconIdentifier
727
728 :aspect:`Data type`
729       string
730
731 :aspect:`Needed by`
732       Backend (form editor)
733
734 :aspect:`Mandatory`
735       Yes
736
737 :aspect:`Default value`
738       Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
739
740 .. :aspect:`Good to know`
741       ToDo
742
743 :aspect:`Description`
744       An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
745       This icon will be shown within
746
747       - :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
748       - :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`.
749       - ``Tree`` component.
750       - "new element" Modal
751
752
753 .. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formEditor.editors-tree:
754
755 formEditor.editors
756 ------------------
757
758 .. toctree::
759
760     formEditor/Index
761
762
763 .. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-concreteconfigurations:
764
765 Concrete configurations
766 =======================
767
768 .. toctree::
769
770     formElementTypes/AdvancedPassword
771     formElementTypes/Checkbox
772     formElementTypes/ContentElement
773     formElementTypes/DatePicker
774     formElementTypes/Fieldset
775     formElementTypes/FileUpload
776     formElementTypes/Form
777     formElementTypes/GridContainer
778     formElementTypes/GridRow
779     formElementTypes/Hidden
780     formElementTypes/Honeypot
781     formElementTypes/ImageUpload
782     formElementTypes/MultiCheckbox
783     formElementTypes/MultiSelect
784     formElementTypes/Page
785     formElementTypes/Password
786     formElementTypes/RadioButton
787     formElementTypes/SingleSelect
788     formElementTypes/StaticText
789     formElementTypes/SummaryPage
790     formElementTypes/Text
791     formElementTypes/Textarea