440c417ac9c02607bdc86666aeb07fdf8d55290c
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Configuration / TypoScript / Elements / Input.ts
1 plugin.tx_form {
2                 # elementPartials
3                 # Used by: frontend, wizard (not implemented right now)
4                 # Overwritable by user: FALSE
5                 #
6                 # Defines the template selection array for the form wizard.
7                 # Each defined item is shown as option within the wizard.
8                 #
9                 # If there is no partialPath property in the userdefined TypoScript
10                 # then elementPartials.ELEMENTNAME.10.partialPath is the default.
11         view {
12                 elementPartials {
13                         INPUT {
14                                 10 {
15                                         displayName = Default
16                                         partialPath = FlatElements/Input
17                                 }
18                         }
19                 }
20         }
21
22         settings {
23                 registeredElements {
24                                 # INPUT
25                                 # Used by: frontend, wizard (not implemented right now)
26                                 # Used ViewHelper: f:form.textfield
27                                 #
28                                 # @ToDo: add more details
29                         INPUT {
30                                         # htmlAttributes
31                                         # Used by: frontend, wizard (not implemented right now)
32                                         # Overwritable by user: FALSE
33                                         #
34                                         # Defines allowed HTML attributes for a specific element.
35                                         # Based on selfhtml documentation version 8.1.2 (see http://wiki.selfhtml.org/wiki/Referenz:HTML/).
36                                         # This is needed to detect and map these strings within the user configured element definition as HTML attributes.
37                                         # As soon as prefix-* is defined every attribute is registered automatically as HTML attribute.
38                                 htmlAttributes {
39                                                 # generic attributes
40                                         10 = id
41                                         20 = class
42                                         30 = accesskey
43                                         40 = contenteditable
44                                         50 = contextmenu
45                                         60 = dir
46                                         70 = draggable
47                                         80 = dropzone
48                                         90 = hidden
49                                         100 = lang
50                                         110 = spellcheck
51                                         120 = style
52                                         130 = tabindex
53                                         140 = title
54                                         150 = data-*
55                                         160 = translate
56                                                 # element specific attributes
57                                         200 = type
58                                         210 = accept
59                                         220 = autocomplete
60                                         230 = autofocus
61                                         240 = checked
62                                         250 = disabled
63                                         260 = list
64                                         270 = inputmode
65                                         280 = max
66                                         290 = maxlength
67                                         300 = min
68                                         310 = minlength
69                                         320 = multiple
70                                         330 = name
71                                         340 = pattern
72                                         350 = placeholder
73                                         360 = readonly
74                                         370 = required
75                                         380 = size
76                                         390 = src
77                                         400 = step
78                                         410 = value
79                                         420 = width
80                                 }
81
82                                         # htmlAttributesUsedByTheViewHelperDirectly
83                                         # Used by: frontend
84                                         # Overwritable by user: FALSE
85                                         #
86                                         # Each HTML attribute defined at ".htmlAttributes" is available as array within the model.
87                                         # This array will be added to the resulting HTML tag.
88                                         # For this purpose the Fluid argument "additionalAttributes" of the ViewHelper is used.
89                                         #
90                                         # Some HTML attributes have to be assigned directly as an argument to the ViewHelper.
91                                         # The htmlAttributesUsedByTheViewHelperDirectly map is used to remove the specified
92                                         # HTML attribute from the "htmlAttributes" array and sets it for the model's "additionalArguments" array.
93                                         #
94                                         # There are two attributes which special behavior:
95                                         #       * disabled
96                                         #       * readonly
97                                         # These attributes can be assigned to the most ViewHelpers but whenever a "disabled" attribute appears
98                                         # the browser will disable this element no matter of the value.
99                                         # See: https://forge.typo3.org/issues/42474
100                                         # Therefore it is held in the htmlAttributes array and the code removes this attribute if its value is set to 0.
101                                 htmlAttributesUsedByTheViewHelperDirectly {
102                                                 # generic attributes
103                                         10 = class
104                                         20 = dir
105                                         30 = id
106                                         40 = lang
107                                         50 = style
108                                         60 = title
109                                         70 = accesskey
110                                         80 = tabindex
111                                         90 = onclick
112                                         100 = name
113                                         110 = value
114                                                 # TextfieldViewHelper
115                                         120 = autofocus
116                                         130 = maxlength
117                                         140 = size
118                                         150 = placeholder
119                                         160 = pattern
120                                         170 = required
121                                         180 = type
122                                 }
123
124                                         # partialPath
125                                         # Used by: frontend, wizard (not implemented right now)
126                                         # Overwritable by user: TRUE
127                                         #
128                                         # The defined partial is used to render the element.
129                                         # The partial paths to the element are build based on the following rule:
130                                         # {$plugin.tx_form.view.partialRootPath}/{$themeName}/@actionName/{$partialPath}.
131                                 partialPath =< plugin.tx_form.view.elementPartials.INPUT.10.partialPath
132
133                                         # visibleInShowAction
134                                         # Used by: frontend
135                                         # Overwritable by user: TRUE
136                                         #
137                                         # If set to 1 this element is displayed in the form.
138                                         # @ToDo: add more details
139                                 visibleInShowAction = 1
140
141                                         # visibleInConfirmationAction
142                                         # Used by: frontend
143                                         # Overwritable by user: TRUE
144                                         #
145                                         # If set to 1 this element is displayed in the confirmation page.
146                                         # @ToDo: add more details
147                                 visibleInConfirmationAction = 1
148
149                                         # visibleInProcessAction
150                                         # Used by: frontend
151                                         # Overwritable by user: TRUE
152                                         #
153                                         # If set to 1 this element is displayed in the mail.
154                                         # @ToDo: add more details
155                                 visibleInMail = 1
156                         }
157                 }
158         }
159 }