Skip to content

Commit 78a2381

Browse files
SgoettschkesSgoettschkes
committed
Documenting the virtual option for types where it makes sense.
1 parent 11b63e3 commit 78a2381

File tree

6 files changed

+34
-3
lines changed

6 files changed

+34
-3
lines changed

‎reference/forms/types/birthday.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ option defaults to 120 years ago to the current year.
3131
| | - `user_timezone`_ |
3232
| | - `invalid_message`_ |
3333
| | - `invalid_message_parameters`_ |
34+
| | - `virtual`_ |
3435
+----------------------+------------------------------------------------------------------------------------------------------------------------+
3536
| Parent type | :doc:`date</reference/forms/types/date>` |
3637
+----------------------+------------------------------------------------------------------------------------------------------------------------+
@@ -75,3 +76,6 @@ These options inherit from the :doc:`date</reference/forms/types/field>` type:
7576

7677
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
7778

79+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
80+
81+
.. include:: /reference/forms/types/options/virtual.rst.inc

‎reference/forms/types/choice.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ option.
2626
| options | - `label`_ |
2727
| | - `read_only`_ |
2828
| | - `error_bubbling`_ |
29+
| | - `virtual`_ |
2930
+-------------+-----------------------------------------------------------------------------+
3031
| Parent type | :doc:`form</reference/forms/types/form>` (if expanded), ``field`` otherwise |
3132
+-------------+-----------------------------------------------------------------------------+
@@ -119,3 +120,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
119120
.. include:: /reference/forms/types/options/read_only.rst.inc
120121

121122
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
123+
124+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
125+
126+
.. include:: /reference/forms/types/options/virtual.rst.inc

‎reference/forms/types/date.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ day, and year) or three select boxes (see the `widget_` option).
3232
+----------------------+-----------------------------------------------------------------------------+
3333
| Inherited | - `invalid_message`_ |
3434
| options | - `invalid_message_parameters`_ |
35+
| | - `virtual`_ |
3536
+----------------------+-----------------------------------------------------------------------------+
3637
| Parent type | ``field`` (if text), ``form`` otherwise |
3738
+----------------------+-----------------------------------------------------------------------------+
@@ -120,4 +121,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
120121

121122
.. include:: /reference/forms/types/options/invalid_message.rst.inc
122123

123-
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
124+
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
125+
126+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
127+
128+
.. include:: /reference/forms/types/options/virtual.rst.inc

‎reference/forms/types/datetime.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
3131
+----------------------+-----------------------------------------------------------------------------+
3232
| Inherited | - `invalid_message`_ |
3333
| options | - `invalid_message_parameters`_ |
34+
| | - `virtual`_ |
3435
+----------------------+-----------------------------------------------------------------------------+
3536
| Parent type | :doc:`form</reference/forms/types/form>` |
3637
+----------------------+-----------------------------------------------------------------------------+
@@ -104,4 +105,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
104105

105106
.. include:: /reference/forms/types/options/invalid_message.rst.inc
106107

107-
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
108+
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
109+
110+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
111+
112+
.. include:: /reference/forms/types/options/virtual.rst.inc

‎reference/forms/types/options/virtual.rst.inc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
virtual
2+
~~~~~~~
3+
4+
**type**: ``boolean`` **default**: ``false``
5+
6+
This option determines if the form will be mapped with data. This can be usefull
7+
if you need a form to structure the view.

‎reference/forms/types/time.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ as a ``DateTime`` object, a string, a timestamp or an array.
2626
+----------------------+-----------------------------------------------------------------------------+
2727
| Inherited | - `invalid_message`_ |
2828
| options | - `invalid_message_parameters`_ |
29+
| | - `virtual`_ |
2930
+----------------------+-----------------------------------------------------------------------------+
3031
| Parent type | form |
3132
+----------------------+-----------------------------------------------------------------------------+
@@ -115,4 +116,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
115116

116117
.. include:: /reference/forms/types/options/invalid_message.rst.inc
117118

118-
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
119+
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
120+
121+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
122+
123+
.. include:: /reference/forms/types/options/virtual.rst.inc

0 commit comments

Comments
 (0)