Skip to content

[#3255] Tried to clarify how to check a box #3256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2013
Merged

[#3255] Tried to clarify how to check a box #3256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions reference/forms/types/checkbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ if the box is unchecked, the value will be set to false.
+-------------+------------------------------------------------------------------------+
| Options | - `value`_ |
+-------------+------------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -47,11 +48,17 @@ value
The value that's actually used as the value for the checkbox. This does
not affect the value that's set on your object.

.. caution::

To make a checkbox checked by default, use the `data`_ option.

Inherited options
-----------------

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/required.rst.inc

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down
11 changes: 9 additions & 2 deletions reference/forms/types/radio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ If you want to have a Boolean field, use :doc:`checkbox </reference/forms/types/
+-------------+---------------------------------------------------------------------+
| Options | - `value`_ |
+-------------+---------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| Inherited | - `data`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand All @@ -41,11 +42,17 @@ value
The value that's actually used as the value for the radio button. This does
not affect the value that's set on your object.

.. caution::

To make a radio button checked by default, use the `data`_ option.

Inherited Options
-----------------

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/required.rst.inc

.. include:: /reference/forms/types/options/label.rst.inc
Expand Down