Skip to content

Commit 362c8b4

Browse files
nykopolweaverryan
authored andcommitted
document overriden options of choice field
1 parent 70feefd commit 362c8b4

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

reference/forms/types/choice.rst

+25-6
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,20 @@ option.
2020
| | - `preferred_choices`_ |
2121
| | - `empty_value`_ |
2222
+-------------+------------------------------------------------------------------------------+
23+
| Overriden | - `empty_data`_ |
24+
| options | - `compound`_ |
25+
| | - `error_bubbling`_ |
26+
+-------------+------------------------------------------------------------------------------+
2327
| Inherited | - `required`_ |
2428
| options | - `label`_ |
2529
| | - `label_attr`_ |
2630
| | - `data`_ |
2731
| | - `read_only`_ |
2832
| | - `disabled`_ |
29-
| | - `error_bubbling`_ |
3033
| | - `error_mapping`_ |
3134
| | - `mapped`_ |
3235
| | - `inherit_data`_ |
3336
| | - `by_reference`_ |
34-
| | - `empty_data`_ |
3537
+-------------+------------------------------------------------------------------------------+
3638
| Parent type | :doc:`form </reference/forms/types/form>` |
3739
+-------------+------------------------------------------------------------------------------+
@@ -109,6 +111,27 @@ can be created to supply the choices.
109111

110112
.. include:: /reference/forms/types/options/empty_value.rst.inc
111113

114+
Overriden options
115+
-----------------
116+
117+
.. include:: /reference/forms/types/options/empty_data.rst.inc
118+
119+
compound
120+
~~~~~~~~
121+
122+
**type**: `̀ boolean`` **default**: same value as ``expanded`` option
123+
124+
This option specifies if a form is compound. The value is by default
125+
overriden by the value of the ``expanded`` option.
126+
127+
error_bubbling
128+
~~~~~~~~~~~~~~
129+
130+
**type**: ``boolean`` **default**: ``false``
131+
132+
Set that error on this field must be attached to the field instead of
133+
the parent field (the form in most cases).
134+
112135
Inherited options
113136
-----------------
114137

@@ -126,14 +149,10 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:
126149

127150
.. include:: /reference/forms/types/options/disabled.rst.inc
128151

129-
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
130-
131152
.. include:: /reference/forms/types/options/error_mapping.rst.inc
132153

133154
.. include:: /reference/forms/types/options/mapped.rst.inc
134155

135156
.. include:: /reference/forms/types/options/inherit_data.rst.inc
136157

137158
.. include:: /reference/forms/types/options/by_reference.rst.inc
138-
139-
.. include:: /reference/forms/types/options/empty_data.rst.inc

0 commit comments

Comments
 (0)