Skip to content

Commit 753dce4

Browse files
nhovratovnhovratov
committed
[DOCS] Document missing properties in Checkbox, Radio and Select
1 parent 73d8d2b commit 753dce4

3 files changed

Lines changed: 533 additions & 0 deletions

File tree

‎Documentation/YamlReference/FieldTypes/Checkbox/Index.rst‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,128 @@ Settings
104104
option. This option receives an array of those strings. By default, the
105105
custom option :yaml:`itemsProcConfig` is allowed.
106106

107+
.. confval:: behaviour.allowLanguageSynchronization
108+
:name: checkbox-behaviour.allowLanguageSynchronization
109+
:required: false
110+
:type: boolean
111+
:default: false
112+
113+
Allows to select if localization uses custom or default language value.
114+
115+
.. confval:: cols
116+
:name: checkbox-cols
117+
:required: false
118+
:type: integer|string
119+
120+
Defines in how many columns the checkboxes are shown. Only meaningful when
121+
multiple :yaml:`items` are defined. Accepts an integer between 1 and 31, or
122+
the string :yaml:`inline`.
123+
124+
.. confval:: eval
125+
:name: checkbox-eval
126+
:required: false
127+
:type: string
128+
129+
Configuration of field evaluation. Possible values:
130+
131+
* :yaml:`maximumRecordsChecked`
132+
* :yaml:`maximumRecordsCheckedInPid`
133+
* :yaml:`maximumRecordsChecked,maximumRecordsCheckedInPid`
134+
135+
Use together with :yaml:`validation` to set the maximum.
136+
137+
.. confval:: fieldControl
138+
:name: checkbox-fieldControl
139+
:required: false
140+
:type: object
141+
142+
See :ref:`TCA fieldControl <t3tca:tca_property_fieldControl>`.
143+
144+
.. confval:: fieldInformation
145+
:name: checkbox-fieldInformation
146+
:required: false
147+
:type: object
148+
149+
See :ref:`TCA fieldInformation <t3tca:tca_property_fieldInformation>`.
150+
151+
.. confval:: fieldWizard
152+
:name: checkbox-fieldWizard
153+
:required: false
154+
:type: object
155+
156+
See :ref:`TCA fieldWizard <t3tca:tca_property_fieldWizard>`.
157+
158+
.. confval:: invertStateDisplay
159+
:name: checkbox-invertStateDisplay
160+
:required: false
161+
:type: boolean
162+
163+
A checkbox is marked checked if the database bit is not set and vice versa.
164+
Applies to all checkboxes. Can also be set per item inside :yaml:`items`.
165+
166+
.. confval:: itemsProcessors
167+
:name: checkbox-itemsProcessors
168+
:required: false
169+
:type: object
170+
171+
A list of PHP classes called to fill or manipulate the items array. Each
172+
entry is keyed by a numeric index and requires a :yaml:`class` property.
173+
An optional :yaml:`parameters` object can be passed to the processor.
174+
175+
Example:
176+
177+
.. code-block:: yaml
178+
179+
itemsProcessors:
180+
0:
181+
class: 'Vendor\Extension\ItemsProcessor\MyProcessor'
182+
parameters:
183+
foo: bar
184+
185+
.. confval:: itemsProcFunc
186+
:name: checkbox-itemsProcFunc
187+
:required: false
188+
:type: string
189+
190+
.. deprecated:: 2.3.0
191+
192+
Use :yaml:`itemsProcessors` instead.
193+
194+
PHP method which is called to fill or manipulate the items array. See
195+
:ref:`TCA itemsProcFunc <t3tca:tca_property_itemsProcFunc>`.
196+
197+
.. confval:: itemsProcConfig
198+
:name: checkbox-itemsProcConfig
199+
:required: false
200+
:type: object
201+
202+
Additional configuration passed to :yaml:`itemsProcFunc`. Must be listed in
203+
:yaml:`allowedCustomProperties` (included by default).
204+
205+
.. confval:: readOnly
206+
:name: checkbox-readOnly
207+
:required: false
208+
:type: boolean
209+
:default: false
210+
211+
Renders the field in a way that the user can see the value but cannot edit it.
212+
213+
.. confval:: validation.maximumRecordsChecked
214+
:name: checkbox-validation.maximumRecordsChecked
215+
:required: false
216+
:type: integer
217+
218+
Maximum number of records that can have this checkbox checked system-wide.
219+
Requires :yaml:`eval: maximumRecordsChecked`.
220+
221+
.. confval:: validation.maximumRecordsCheckedInPid
222+
:name: checkbox-validation.maximumRecordsCheckedInPid
223+
:required: false
224+
:type: integer
225+
226+
Maximum number of records that can have this checkbox checked within a page.
227+
Requires :yaml:`eval: maximumRecordsCheckedInPid`.
228+
107229

108230
Examples
109231
========

‎Documentation/YamlReference/FieldTypes/Radio/Index.rst‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,82 @@ Settings
8080
option. This option receives an array of those strings. By default, the
8181
custom option :yaml:`itemsProcConfig` is allowed.
8282

83+
.. confval:: behaviour.allowLanguageSynchronization
84+
:name: radio-behaviour.allowLanguageSynchronization
85+
:required: false
86+
:type: boolean
87+
:default: false
88+
89+
Allows to select if localization uses custom or default language value.
90+
91+
.. confval:: fieldControl
92+
:name: radio-fieldControl
93+
:required: false
94+
:type: object
95+
96+
See :ref:`TCA fieldControl <t3tca:tca_property_fieldControl>`.
97+
98+
.. confval:: fieldInformation
99+
:name: radio-fieldInformation
100+
:required: false
101+
:type: object
102+
103+
See :ref:`TCA fieldInformation <t3tca:tca_property_fieldInformation>`.
104+
105+
.. confval:: fieldWizard
106+
:name: radio-fieldWizard
107+
:required: false
108+
:type: object
109+
110+
See :ref:`TCA fieldWizard <t3tca:tca_property_fieldWizard>`.
111+
112+
.. confval:: itemsProcessors
113+
:name: radio-itemsProcessors
114+
:required: false
115+
:type: object
116+
117+
A list of PHP classes called to fill or manipulate the items array. Each
118+
entry is keyed by a numeric index and requires a :yaml:`class` property.
119+
An optional :yaml:`parameters` object can be passed to the processor.
120+
121+
Example:
122+
123+
.. code-block:: yaml
124+
125+
itemsProcessors:
126+
0:
127+
class: 'Vendor\Extension\ItemsProcessor\MyProcessor'
128+
parameters:
129+
foo: bar
130+
131+
.. confval:: itemsProcFunc
132+
:name: radio-itemsProcFunc
133+
:required: false
134+
:type: string
135+
136+
.. deprecated:: 2.3.0
137+
138+
Use :yaml:`itemsProcessors` instead.
139+
140+
PHP method which is called to fill or manipulate the items array. See
141+
:ref:`TCA itemsProcFunc <t3tca:tca_property_itemsProcFunc>`.
142+
143+
.. confval:: itemsProcConfig
144+
:name: radio-itemsProcConfig
145+
:required: false
146+
:type: object
147+
148+
Additional configuration passed to :yaml:`itemsProcFunc`. Must be listed in
149+
:yaml:`allowedCustomProperties` (included by default).
150+
151+
.. confval:: readOnly
152+
:name: radio-readOnly
153+
:required: false
154+
:type: boolean
155+
:default: false
156+
157+
Renders the field in a way that the user can see the value but cannot edit it.
158+
83159
Example
84160
=======
85161

0 commit comments

Comments
 (0)