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