innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

[1.11.x] Fixed #27918 -- Documented ChoiceWidget.option_template_name 

Backport of 0d83052e52 from master
This commit is contained in:
Pavel Kulikov 2017-03-11 10:11:44 +03:00 committed by Tim Graham
parent 1ed4dab20f
commit 3c1ed1d336
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/ref/forms/widgets.txt
View File

@ -621,6 +621,14 @@ These widgets make use of the HTML elements ``input`` and ``textarea``.
Selector and checkbox widgets
-----------------------------
These widgets make use of the HTML elements ``<select>``,
``<input type='checkbox'>``, and ``<input type='radio'>``.
Widgets that render multiple choices have an ``option_template_name`` attribute
that specifies the template used to render each choice. For example, for the
:class:`Select` widget, ``select_option.html`` renders the ``<option>`` for a
``<select>``.
``CheckboxInput``
~~~~~~~~~~~~~~~~~
@ -643,6 +651,7 @@ Selector and checkbox widgets
.. class:: Select
* ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
* Renders as: ``<select><option ...>...</select>``
.. attribute:: Select.choices
@ -657,6 +666,7 @@ Selector and checkbox widgets
.. class:: NullBooleanSelect
* ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
Select widget with options 'Unknown', 'Yes' and 'No'
@ -666,6 +676,7 @@ Selector and checkbox widgets
.. class:: SelectMultiple
* ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
Similar to :class:`Select`, but allows multiple selection:
``<select multiple='multiple'>...</select>``
@ -676,6 +687,7 @@ Selector and checkbox widgets
.. class:: RadioSelect
* ``template_name``: ``'django/forms/widgets/radio.html'``
* ``option_template_name``: ``'django/forms/widgets/radio_option.html'``
Similar to :class:`Select`, but rendered as a list of radio buttons within
``<li>`` tags:
@ -770,6 +782,7 @@ Selector and checkbox widgets
.. class:: CheckboxSelectMultiple
* ``template_name``: ``'django/forms/widgets/checkbox_select.html'``
* ``option_template_name``: ``'django/forms/widgets/checkbox_option.html'``
Similar to :class:`SelectMultiple`, but rendered as a list of check
buttons: