Skip to content

Commit 7e06f9f

Browse files
TheMelterweaverryan
authored andcommitted
Added missing options.
1 parent 788292b commit 7e06f9f

File tree

7 files changed

+32
-0
lines changed

7 files changed

+32
-0
lines changed

reference/forms/types/checkbox.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ if the box is unchecked, the value will be set to false.
1212
| Rendered as | ``input`` ``checkbox`` field |
1313
+-------------+------------------------------------------------------------------------+
1414
| Options | - `value`_ |
15+
| | - `checked`_ |
1516
+-------------+------------------------------------------------------------------------+
1617
| Inherited | - `required`_ |
1718
| options | - `label`_ |
@@ -47,6 +48,12 @@ value
4748
The value that's actually used as the value for the checkbox. This does
4849
not affect the value that's set on your object.
4950

51+
checked
52+
~~~~~~~
53+
54+
**type**: ``mixed`` **default**: ``1``
55+
56+
5057
Inherited options
5158
-----------------
5259

reference/forms/types/datetime.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
2828
| | - `with_seconds`_ |
2929
| | - `data_timezone`_ |
3030
| | - `user_timezone`_ |
31+
| | - `empty_value`_ |
3132
+----------------------+-----------------------------------------------------------------------------+
3233
| Inherited | - `invalid_message`_ |
3334
| options | - `invalid_message_parameters`_ |
@@ -101,6 +102,8 @@ for more details.
101102

102103
.. include:: /reference/forms/types/options/user_timezone.rst.inc
103104

105+
.. include:: /reference/forms/types/options/empty_value.rst.inc
106+
104107
Inherited options
105108
-----------------
106109

reference/forms/types/form.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ on all fields.
3030
.. include:: /reference/forms/types/options/attr.rst.inc
3131

3232
.. include:: /reference/forms/types/options/translation_domain.rst.inc
33+
34+
virtual
35+
-------
36+
37+
See :doc:`How to use the Virtual Form Field Option</cookbook/form/use_virtuals_forms>`

reference/forms/types/integer.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6
1616
| Rendered as | ``input`` ``text`` field |
1717
+-------------+-----------------------------------------------------------------------+
1818
| Options | - `rounding_mode`_ |
19+
| | - `precision`_ |
1920
| | - `grouping`_ |
2021
+-------------+-----------------------------------------------------------------------+
2122
| Inherited | - `required`_ |
@@ -36,6 +37,8 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6
3637
Field Options
3738
-------------
3839

40+
.. include:: /reference/forms/types/options/precision.rst.inc
41+
3942
rounding_mode
4043
~~~~~~~~~~~~~
4144

reference/forms/types/number.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ you want to use for your number.
3333
Field Options
3434
-------------
3535

36+
.. include:: /reference/forms/types/options/precision.rst.inc
37+
3638
precision
3739
~~~~~~~~~
3840

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
precision
2+
~~~~~~~~~
3+
4+
**type**: ``integer`` **default**: Locale-specific (usually around ``3``)
5+
6+
This specifies how many decimals will be allowed until the field rounds
7+
the submitted value (via ``rounding_mode``). For example, if ``precision``
8+
is set to ``2``, a submitted value of ``20.123`` will be rounded to,
9+
for example, ``20.12`` (depending on your ``rounding_mode``).

reference/forms/types/time.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ as a ``DateTime`` object, a string, a timestamp or an array.
2323
| | - `seconds`_ |
2424
| | - `data_timezone`_ |
2525
| | - `user_timezone`_ |
26+
| | - `empty_value`_ |
2627
+----------------------+-----------------------------------------------------------------------------+
2728
| Overridden Options | - `by_reference`_ |
2829
| | - `error_bubbling`_ |
@@ -116,6 +117,8 @@ this format.
116117

117118
.. include:: /reference/forms/types/options/user_timezone.rst.inc
118119

120+
.. include:: /reference/forms/types/options/empty_value.rst.inc
121+
119122
Overridden Options
120123
------------------
121124

0 commit comments

Comments
 (0)