p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed #27918 -- Documented ChoiceWidget.option_template_name

This commit is contained in:
Pavel Kulikov 2017-03-11 10:11:44 +03:00 committed by Tim Graham
parent 36f2262741
commit 0d83052e52
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

@ -612,6 +612,14 @@ These widgets make use of the HTML elements ``input`` and ``textarea``.
Selector and checkbox widgets 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`` ``CheckboxInput``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -634,6 +642,7 @@ Selector and checkbox widgets
.. class:: Select .. class:: Select
* ``template_name``: ``'django/forms/widgets/select.html'`` * ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
* Renders as: ``<select><option ...>...</select>`` * Renders as: ``<select><option ...>...</select>``
.. attribute:: Select.choices .. attribute:: Select.choices
@ -648,6 +657,7 @@ Selector and checkbox widgets
.. class:: NullBooleanSelect .. class:: NullBooleanSelect
* ``template_name``: ``'django/forms/widgets/select.html'`` * ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
Select widget with options 'Unknown', 'Yes' and 'No' Select widget with options 'Unknown', 'Yes' and 'No'
@ -657,6 +667,7 @@ Selector and checkbox widgets
.. class:: SelectMultiple .. class:: SelectMultiple
* ``template_name``: ``'django/forms/widgets/select.html'`` * ``template_name``: ``'django/forms/widgets/select.html'``
* ``option_template_name``: ``'django/forms/widgets/select_option.html'``
Similar to :class:`Select`, but allows multiple selection: Similar to :class:`Select`, but allows multiple selection:
``<select multiple='multiple'>...</select>`` ``<select multiple='multiple'>...</select>``
@ -667,6 +678,7 @@ Selector and checkbox widgets
.. class:: RadioSelect .. class:: RadioSelect
* ``template_name``: ``'django/forms/widgets/radio.html'`` * ``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 Similar to :class:`Select`, but rendered as a list of radio buttons within
``<li>`` tags: ``<li>`` tags:
@ -761,6 +773,7 @@ Selector and checkbox widgets
.. class:: CheckboxSelectMultiple .. class:: CheckboxSelectMultiple
* ``template_name``: ``'django/forms/widgets/checkbox_select.html'`` * ``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 Similar to :class:`SelectMultiple`, but rendered as a list of check
buttons: buttons: