widgets.txt 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806
  1. =======
  2. Widgets
  3. =======
  4. .. module:: django.forms.widgets
  5. :synopsis: Django's built-in form widgets.
  6. .. currentmodule:: django.forms
  7. A widget is Django's representation of a HTML input element. The widget
  8. handles the rendering of the HTML, and the extraction of data from a GET/POST
  9. dictionary that corresponds to the widget.
  10. .. tip::
  11. Widgets should not be confused with the :doc:`form fields </ref/forms/fields>`.
  12. Form fields deal with the logic of input validation and are used directly
  13. in templates. Widgets deal with rendering of HTML form input elements on
  14. the web page and extraction of raw submitted data. However, widgets do
  15. need to be :ref:`assigned <widget-to-field>` to form fields.
  16. .. _widget-to-field:
  17. Specifying widgets
  18. ------------------
  19. Whenever you specify a field on a form, Django will use a default widget
  20. that is appropriate to the type of data that is to be displayed. To find
  21. which widget is used on which field, see the documentation about
  22. :ref:`built-in-fields`.
  23. However, if you want to use a different widget for a field, you can
  24. just use the :attr:`~Field.widget` argument on the field definition. For
  25. example::
  26. from django import forms
  27. class CommentForm(forms.Form):
  28. name = forms.CharField()
  29. url = forms.URLField()
  30. comment = forms.CharField(widget=forms.Textarea)
  31. This would specify a form with a comment that uses a larger :class:`Textarea`
  32. widget, rather than the default :class:`TextInput` widget.
  33. Setting arguments for widgets
  34. -----------------------------
  35. Many widgets have optional extra arguments; they can be set when defining the
  36. widget on the field. In the following example, the
  37. :attr:`~django.forms.extras.widgets.SelectDateWidget.years` attribute is set
  38. for a :class:`~django.forms.extras.widgets.SelectDateWidget`::
  39. from django import forms
  40. from django.forms.extras.widgets import SelectDateWidget
  41. BIRTH_YEAR_CHOICES = ('1980', '1981', '1982')
  42. FAVORITE_COLORS_CHOICES = (('blue', 'Blue'),
  43. ('green', 'Green'),
  44. ('black', 'Black'))
  45. class SimpleForm(forms.Form):
  46. birth_year = forms.DateField(widget=SelectDateWidget(years=BIRTH_YEAR_CHOICES))
  47. favorite_colors = forms.MultipleChoiceField(required=False,
  48. widget=forms.CheckboxSelectMultiple, choices=FAVORITE_COLORS_CHOICES)
  49. See the :ref:`built-in widgets` for more information about which widgets
  50. are available and which arguments they accept.
  51. Widgets inheriting from the Select widget
  52. -----------------------------------------
  53. Widgets inheriting from the :class:`Select` widget deal with choices. They
  54. present the user with a list of options to choose from. The different widgets
  55. present this choice differently; the :class:`Select` widget itself uses a
  56. ``<select>`` HTML list representation, while :class:`RadioSelect` uses radio
  57. buttons.
  58. :class:`Select` widgets are used by default on :class:`ChoiceField` fields. The
  59. choices displayed on the widget are inherited from the :class:`ChoiceField` and
  60. changing :attr:`ChoiceField.choices` will update :attr:`Select.choices`. For
  61. example::
  62. >>> from django import forms
  63. >>> CHOICES = (('1', 'First',), ('2', 'Second',))
  64. >>> choice_field = forms.ChoiceField(widget=forms.RadioSelect, choices=CHOICES)
  65. >>> choice_field.choices
  66. [('1', 'First'), ('2', 'Second')]
  67. >>> choice_field.widget.choices
  68. [('1', 'First'), ('2', 'Second')]
  69. >>> choice_field.widget.choices = ()
  70. >>> choice_field.choices = (('1', 'First and only',),)
  71. >>> choice_field.widget.choices
  72. [('1', 'First and only')]
  73. Widgets which offer a :attr:`~Select.choices` attribute can however be used
  74. with fields which are not based on choice -- such as a :class:`CharField` --
  75. but it is recommended to use a :class:`ChoiceField`-based field when the
  76. choices are inherent to the model and not just the representational widget.
  77. Customizing widget instances
  78. ----------------------------
  79. When Django renders a widget as HTML, it only renders very minimal markup -
  80. Django doesn't add class names, or any other widget-specific attributes. This
  81. means, for example, that all :class:`TextInput` widgets will appear the same
  82. on your Web pages.
  83. There are two ways to customize widgets: :ref:`per widget instance
  84. <styling-widget-instances>` and :ref:`per widget class <styling-widget-classes>`.
  85. .. _styling-widget-instances:
  86. Styling widget instances
  87. ^^^^^^^^^^^^^^^^^^^^^^^^
  88. If you want to make one widget instance look different from another, you will
  89. need to specify additional attributes at the time when the widget object is
  90. instantiated and assigned to a form field (and perhaps add some rules to your
  91. CSS files).
  92. For example, take the following simple form::
  93. from django import forms
  94. class CommentForm(forms.Form):
  95. name = forms.CharField()
  96. url = forms.URLField()
  97. comment = forms.CharField()
  98. This form will include three default :class:`TextInput` widgets, with default
  99. rendering -- no CSS class, no extra attributes. This means that the input boxes
  100. provided for each widget will be rendered exactly the same::
  101. >>> f = CommentForm(auto_id=False)
  102. >>> f.as_table()
  103. <tr><th>Name:</th><td><input type="text" name="name" /></td></tr>
  104. <tr><th>Url:</th><td><input type="url" name="url"/></td></tr>
  105. <tr><th>Comment:</th><td><input type="text" name="comment" /></td></tr>
  106. On a real Web page, you probably don't want every widget to look the same. You
  107. might want a larger input element for the comment, and you might want the
  108. 'name' widget to have some special CSS class. It is also possible to specify
  109. the 'type' attribute to take advantage of the new HTML5 input types. To do
  110. this, you use the :attr:`Widget.attrs` argument when creating the widget::
  111. class CommentForm(forms.Form):
  112. name = forms.CharField(widget=forms.TextInput(attrs={'class': 'special'}))
  113. url = forms.URLField()
  114. comment = forms.CharField(widget=forms.TextInput(attrs={'size': '40'}))
  115. Django will then include the extra attributes in the rendered output:
  116. >>> f = CommentForm(auto_id=False)
  117. >>> f.as_table()
  118. <tr><th>Name:</th><td><input type="text" name="name" class="special"/></td></tr>
  119. <tr><th>Url:</th><td><input type="url" name="url"/></td></tr>
  120. <tr><th>Comment:</th><td><input type="text" name="comment" size="40"/></td></tr>
  121. You can also set the HTML ``id`` using :attr:`~Widget.attrs`. See
  122. :attr:`BoundField.id_for_label` for an example.
  123. .. _styling-widget-classes:
  124. Styling widget classes
  125. ^^^^^^^^^^^^^^^^^^^^^^
  126. With widgets, it is possible to add assets (``css`` and ``javascript``)
  127. and more deeply customize their appearance and behavior.
  128. In a nutshell, you will need to subclass the widget and either
  129. :ref:`define a "Media" inner class <assets-as-a-static-definition>` or
  130. :ref:`create a "media" property <dynamic-property>`.
  131. These methods involve somewhat advanced Python programming and are described in
  132. detail in the :doc:`Form Assets </topics/forms/media>` topic guide.
  133. .. _base-widget-classes:
  134. Base Widget classes
  135. -------------------
  136. Base widget classes :class:`Widget` and :class:`MultiWidget` are subclassed by
  137. all the :ref:`built-in widgets <built-in widgets>` and may serve as a
  138. foundation for custom widgets.
  139. .. class:: Widget(attrs=None)
  140. This abstract class cannot be rendered, but provides the basic attribute
  141. :attr:`~Widget.attrs`. You may also implement or override the
  142. :meth:`~Widget.render()` method on custom widgets.
  143. .. attribute:: Widget.attrs
  144. A dictionary containing HTML attributes to be set on the rendered
  145. widget.
  146. .. code-block:: python
  147. >>> from django import forms
  148. >>> name = forms.TextInput(attrs={'size': 10, 'title': 'Your name',})
  149. >>> name.render('name', 'A name')
  150. '<input title="Your name" type="text" name="name" value="A name" size="10" />'
  151. .. versionchanged:: 1.8
  152. If you assign a value of ``True`` or ``False`` to an attribute,
  153. it will be rendered as an HTML5 boolean attribute::
  154. >>> name = forms.TextInput(attrs={'required': True})
  155. >>> name.render('name', 'A name')
  156. '<input name="name" type="text" value="A name" required />'
  157. >>>
  158. >>> name = forms.TextInput(attrs={'required': False})
  159. >>> name.render('name', 'A name')
  160. '<input name="name" type="text" value="A name" />'
  161. .. method:: render(name, value, attrs=None)
  162. Returns HTML for the widget, as a Unicode string. This method must be
  163. implemented by the subclass, otherwise ``NotImplementedError`` will be
  164. raised.
  165. The 'value' given is not guaranteed to be valid input, therefore
  166. subclass implementations should program defensively.
  167. .. method:: value_from_datadict(data, files, name)
  168. Given a dictionary of data and this widget's name, returns the value
  169. of this widget. Returns ``None`` if a value wasn't provided.
  170. .. class:: MultiWidget(widgets, attrs=None)
  171. A widget that is composed of multiple widgets.
  172. :class:`~django.forms.MultiWidget` works hand in hand with the
  173. :class:`~django.forms.MultiValueField`.
  174. :class:`MultiWidget` has one required argument:
  175. .. attribute:: MultiWidget.widgets
  176. An iterable containing the widgets needed.
  177. And one required method:
  178. .. method:: decompress(value)
  179. This method takes a single "compressed" value from the field and
  180. returns a list of "decompressed" values. The input value can be
  181. assumed valid, but not necessarily non-empty.
  182. This method **must be implemented** by the subclass, and since the
  183. value may be empty, the implementation must be defensive.
  184. The rationale behind "decompression" is that it is necessary to "split"
  185. the combined value of the form field into the values for each widget.
  186. An example of this is how :class:`SplitDateTimeWidget` turns a
  187. :class:`~datetime.datetime` value into a list with date and time split
  188. into two separate values::
  189. from django.forms import MultiWidget
  190. class SplitDateTimeWidget(MultiWidget):
  191. # ...
  192. def decompress(self, value):
  193. if value:
  194. return [value.date(), value.time().replace(microsecond=0)]
  195. return [None, None]
  196. .. tip::
  197. Note that :class:`~django.forms.MultiValueField` has a
  198. complementary method :meth:`~django.forms.MultiValueField.compress`
  199. with the opposite responsibility - to combine cleaned values of
  200. all member fields into one.
  201. Other methods that may be useful to override include:
  202. .. method:: render(name, value, attrs=None)
  203. Argument ``value`` is handled differently in this method from the
  204. subclasses of :class:`~Widget` because it has to figure out how to
  205. split a single value for display in multiple widgets.
  206. The ``value`` argument used when rendering can be one of two things:
  207. * A ``list``.
  208. * A single value (e.g., a string) that is the "compressed" representation
  209. of a ``list`` of values.
  210. If ``value`` is a list, the output of :meth:`~MultiWidget.render` will
  211. be a concatenation of rendered child widgets. If ``value`` is not a
  212. list, it will first be processed by the method
  213. :meth:`~MultiWidget.decompress()` to create the list and then rendered.
  214. When ``render()`` executes its HTML rendering, each value in the list
  215. is rendered with the corresponding widget -- the first value is
  216. rendered in the first widget, the second value is rendered in the
  217. second widget, etc.
  218. Unlike in the single value widgets, method :meth:`~MultiWidget.render`
  219. need not be implemented in the subclasses.
  220. .. method:: format_output(rendered_widgets)
  221. Given a list of rendered widgets (as strings), returns a Unicode string
  222. representing the HTML for the whole lot.
  223. This hook allows you to format the HTML design of the widgets any way
  224. you'd like.
  225. Here's an example widget which subclasses :class:`MultiWidget` to display
  226. a date with the day, month, and year in different select boxes. This widget
  227. is intended to be used with a :class:`~django.forms.DateField` rather than
  228. a :class:`~django.forms.MultiValueField`, thus we have implemented
  229. :meth:`~Widget.value_from_datadict`::
  230. from datetime import date
  231. from django.forms import widgets
  232. class DateSelectorWidget(widgets.MultiWidget):
  233. def __init__(self, attrs=None):
  234. # create choices for days, months, years
  235. # example below, the rest snipped for brevity.
  236. years = [(year, year) for year in (2011, 2012, 2013)]
  237. _widgets = (
  238. widgets.Select(attrs=attrs, choices=days),
  239. widgets.Select(attrs=attrs, choices=months),
  240. widgets.Select(attrs=attrs, choices=years),
  241. )
  242. super(DateSelectorWidget, self).__init__(_widgets, attrs)
  243. def decompress(self, value):
  244. if value:
  245. return [value.day, value.month, value.year]
  246. return [None, None, None]
  247. def format_output(self, rendered_widgets):
  248. return ''.join(rendered_widgets)
  249. def value_from_datadict(self, data, files, name):
  250. datelist = [
  251. widget.value_from_datadict(data, files, name + '_%s' % i)
  252. for i, widget in enumerate(self.widgets)]
  253. try:
  254. D = date(day=int(datelist[0]), month=int(datelist[1]),
  255. year=int(datelist[2]))
  256. except ValueError:
  257. return ''
  258. else:
  259. return str(D)
  260. The constructor creates several :class:`Select` widgets in a tuple. The
  261. ``super`` class uses this tuple to setup the widget.
  262. The :meth:`~MultiWidget.format_output` method is fairly vanilla here (in
  263. fact, it's the same as what's been implemented as the default for
  264. ``MultiWidget``), but the idea is that you could add custom HTML between
  265. the widgets should you wish.
  266. The required method :meth:`~MultiWidget.decompress` breaks up a
  267. ``datetime.date`` value into the day, month, and year values corresponding
  268. to each widget. Note how the method handles the case where ``value`` is
  269. ``None``.
  270. The default implementation of :meth:`~Widget.value_from_datadict` returns
  271. a list of values corresponding to each ``Widget``. This is appropriate
  272. when using a ``MultiWidget`` with a :class:`~django.forms.MultiValueField`,
  273. but since we want to use this widget with a :class:`~django.forms.DateField`
  274. which takes a single value, we have overridden this method to combine the
  275. data of all the subwidgets into a ``datetime.date``. The method extracts
  276. data from the ``POST`` dictionary and constructs and validates the date.
  277. If it is valid, we return the string, otherwise, we return an empty string
  278. which will cause ``form.is_valid`` to return ``False``.
  279. .. _built-in widgets:
  280. Built-in widgets
  281. ----------------
  282. Django provides a representation of all the basic HTML widgets, plus some
  283. commonly used groups of widgets in the ``django.forms.widgets`` module,
  284. including :ref:`the input of text <text-widgets>`, :ref:`various checkboxes
  285. and selectors <selector-widgets>`, :ref:`uploading files <file-upload-widgets>`,
  286. and :ref:`handling of multi-valued input <composite-widgets>`.
  287. .. _text-widgets:
  288. Widgets handling input of text
  289. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  290. These widgets make use of the HTML elements ``input`` and ``textarea``.
  291. ``TextInput``
  292. ~~~~~~~~~~~~~
  293. .. class:: TextInput
  294. Text input: ``<input type="text" ...>``
  295. ``NumberInput``
  296. ~~~~~~~~~~~~~~~
  297. .. class:: NumberInput
  298. Text input: ``<input type="number" ...>``
  299. Beware that not all browsers support entering localized numbers in
  300. ``number`` input types. Django itself avoids using them for fields having
  301. their :attr:`~django.forms.Field.localize` property to ``True``.
  302. ``EmailInput``
  303. ~~~~~~~~~~~~~~
  304. .. class:: EmailInput
  305. Text input: ``<input type="email" ...>``
  306. ``URLInput``
  307. ~~~~~~~~~~~~
  308. .. class:: URLInput
  309. Text input: ``<input type="url" ...>``
  310. ``PasswordInput``
  311. ~~~~~~~~~~~~~~~~~
  312. .. class:: PasswordInput
  313. Password input: ``<input type='password' ...>``
  314. Takes one optional argument:
  315. .. attribute:: PasswordInput.render_value
  316. Determines whether the widget will have a value filled in when the
  317. form is re-displayed after a validation error (default is ``False``).
  318. ``HiddenInput``
  319. ~~~~~~~~~~~~~~~
  320. .. class:: HiddenInput
  321. Hidden input: ``<input type='hidden' ...>``
  322. Note that there also is a :class:`MultipleHiddenInput` widget that
  323. encapsulates a set of hidden input elements.
  324. ``DateInput``
  325. ~~~~~~~~~~~~~
  326. .. class:: DateInput
  327. Date input as a simple text box: ``<input type='text' ...>``
  328. Takes same arguments as :class:`TextInput`, with one more optional argument:
  329. .. attribute:: DateInput.format
  330. The format in which this field's initial value will be displayed.
  331. If no ``format`` argument is provided, the default format is the first
  332. format found in :setting:`DATE_INPUT_FORMATS` and respects
  333. :ref:`format-localization`.
  334. ``DateTimeInput``
  335. ~~~~~~~~~~~~~~~~~
  336. .. class:: DateTimeInput
  337. Date/time input as a simple text box: ``<input type='text' ...>``
  338. Takes same arguments as :class:`TextInput`, with one more optional argument:
  339. .. attribute:: DateTimeInput.format
  340. The format in which this field's initial value will be displayed.
  341. If no ``format`` argument is provided, the default format is the first
  342. format found in :setting:`DATETIME_INPUT_FORMATS` and respects
  343. :ref:`format-localization`.
  344. ``TimeInput``
  345. ~~~~~~~~~~~~~
  346. .. class:: TimeInput
  347. Time input as a simple text box: ``<input type='text' ...>``
  348. Takes same arguments as :class:`TextInput`, with one more optional argument:
  349. .. attribute:: TimeInput.format
  350. The format in which this field's initial value will be displayed.
  351. If no ``format`` argument is provided, the default format is the first
  352. format found in :setting:`TIME_INPUT_FORMATS` and respects
  353. :ref:`format-localization`.
  354. ``Textarea``
  355. ~~~~~~~~~~~~
  356. .. class:: Textarea
  357. Text area: ``<textarea>...</textarea>``
  358. .. _selector-widgets:
  359. Selector and checkbox widgets
  360. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  361. ``CheckboxInput``
  362. ~~~~~~~~~~~~~~~~~
  363. .. class:: CheckboxInput
  364. Checkbox: ``<input type='checkbox' ...>``
  365. Takes one optional argument:
  366. .. attribute:: CheckboxInput.check_test
  367. A callable that takes the value of the ``CheckboxInput`` and returns
  368. ``True`` if the checkbox should be checked for that value.
  369. ``Select``
  370. ~~~~~~~~~~
  371. .. class:: Select
  372. Select widget: ``<select><option ...>...</select>``
  373. .. attribute:: Select.choices
  374. This attribute is optional when the form field does not have a
  375. ``choices`` attribute. If it does, it will override anything you set
  376. here when the attribute is updated on the :class:`Field`.
  377. ``NullBooleanSelect``
  378. ~~~~~~~~~~~~~~~~~~~~~
  379. .. class:: NullBooleanSelect
  380. Select widget with options 'Unknown', 'Yes' and 'No'
  381. ``SelectMultiple``
  382. ~~~~~~~~~~~~~~~~~~
  383. .. class:: SelectMultiple
  384. Similar to :class:`Select`, but allows multiple selection:
  385. ``<select multiple='multiple'>...</select>``
  386. ``RadioSelect``
  387. ~~~~~~~~~~~~~~~
  388. .. class:: RadioSelect
  389. Similar to :class:`Select`, but rendered as a list of radio buttons within
  390. ``<li>`` tags:
  391. .. code-block:: html
  392. <ul>
  393. <li><input type='radio' name='...'></li>
  394. ...
  395. </ul>
  396. For more granular control over the generated markup, you can loop over the
  397. radio buttons in the template. Assuming a form ``myform`` with a field
  398. ``beatles`` that uses a ``RadioSelect`` as its widget:
  399. .. code-block:: html+django
  400. {% for radio in myform.beatles %}
  401. <div class="myradio">
  402. {{ radio }}
  403. </div>
  404. {% endfor %}
  405. This would generate the following HTML:
  406. .. code-block:: html
  407. <div class="myradio">
  408. <label for="id_beatles_0"><input id="id_beatles_0" name="beatles" type="radio" value="john" /> John</label>
  409. </div>
  410. <div class="myradio">
  411. <label for="id_beatles_1"><input id="id_beatles_1" name="beatles" type="radio" value="paul" /> Paul</label>
  412. </div>
  413. <div class="myradio">
  414. <label for="id_beatles_2"><input id="id_beatles_2" name="beatles" type="radio" value="george" /> George</label>
  415. </div>
  416. <div class="myradio">
  417. <label for="id_beatles_3"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" /> Ringo</label>
  418. </div>
  419. That included the ``<label>`` tags. To get more granular, you can use each
  420. radio button's ``tag``, ``choice_label`` and ``id_for_label`` attributes.
  421. For example, this template...
  422. .. code-block:: html+django
  423. {% for radio in myform.beatles %}
  424. <label for="{{ radio.id_for_label }}">
  425. {{ radio.choice_label }}
  426. <span class="radio">{{ radio.tag }}</span>
  427. </label>
  428. {% endfor %}
  429. ...will result in the following HTML:
  430. .. code-block:: html
  431. <label for="id_beatles_0">
  432. John
  433. <span class="radio"><input id="id_beatles_0" name="beatles" type="radio" value="john" /></span>
  434. </label>
  435. <label for="id_beatles_1">
  436. Paul
  437. <span class="radio"><input id="id_beatles_1" name="beatles" type="radio" value="paul" /></span>
  438. </label>
  439. <label for="id_beatles_2">
  440. George
  441. <span class="radio"><input id="id_beatles_2" name="beatles" type="radio" value="george" /></span>
  442. </label>
  443. <label for="id_beatles_3">
  444. Ringo
  445. <span class="radio"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" /></span>
  446. </label>
  447. If you decide not to loop over the radio buttons -- e.g., if your template
  448. simply includes ``{{ myform.beatles }}`` -- they'll be output in a ``<ul>``
  449. with ``<li>`` tags, as above.
  450. The outer ``<ul>`` container will receive the ``id`` attribute defined on
  451. the widget.
  452. .. versionchanged:: 1.7
  453. When looping over the radio buttons, the ``label`` and ``input`` tags include
  454. ``for`` and ``id`` attributes, respectively. Each radio button has an
  455. ``id_for_label`` attribute to output the element's ID.
  456. ``CheckboxSelectMultiple``
  457. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  458. .. class:: CheckboxSelectMultiple
  459. Similar to :class:`SelectMultiple`, but rendered as a list of check
  460. buttons:
  461. .. code-block:: html
  462. <ul>
  463. <li><input type='checkbox' name='...' ></li>
  464. ...
  465. </ul>
  466. The outer ``<ul>`` container will receive the ``id`` attribute defined on
  467. the widget.
  468. Like :class:`RadioSelect`, you can now loop over the individual checkboxes making
  469. up the lists. See the documentation of :class:`RadioSelect` for more details.
  470. .. versionchanged:: 1.7
  471. When looping over the checkboxes, the ``label`` and ``input`` tags include
  472. ``for`` and ``id`` attributes, respectively. Each checkbox has an
  473. ``id_for_label`` attribute to output the element's ID.
  474. .. _file-upload-widgets:
  475. File upload widgets
  476. ^^^^^^^^^^^^^^^^^^^
  477. ``FileInput``
  478. ~~~~~~~~~~~~~
  479. .. class:: FileInput
  480. File upload input: ``<input type='file' ...>``
  481. ``ClearableFileInput``
  482. ~~~~~~~~~~~~~~~~~~~~~~
  483. .. class:: ClearableFileInput
  484. File upload input: ``<input type='file' ...>``, with an additional checkbox
  485. input to clear the field's value, if the field is not required and has
  486. initial data.
  487. .. _composite-widgets:
  488. Composite widgets
  489. ^^^^^^^^^^^^^^^^^
  490. ``MultipleHiddenInput``
  491. ~~~~~~~~~~~~~~~~~~~~~~~
  492. .. class:: MultipleHiddenInput
  493. Multiple ``<input type='hidden' ...>`` widgets.
  494. A widget that handles multiple hidden widgets for fields that have a list
  495. of values.
  496. .. attribute:: MultipleHiddenInput.choices
  497. This attribute is optional when the form field does not have a
  498. ``choices`` attribute. If it does, it will override anything you set
  499. here when the attribute is updated on the :class:`Field`.
  500. ``SplitDateTimeWidget``
  501. ~~~~~~~~~~~~~~~~~~~~~~~
  502. .. class:: SplitDateTimeWidget
  503. Wrapper (using :class:`MultiWidget`) around two widgets: :class:`DateInput`
  504. for the date, and :class:`TimeInput` for the time.
  505. ``SplitDateTimeWidget`` has two optional attributes:
  506. .. attribute:: SplitDateTimeWidget.date_format
  507. Similar to :attr:`DateInput.format`
  508. .. attribute:: SplitDateTimeWidget.time_format
  509. Similar to :attr:`TimeInput.format`
  510. ``SplitHiddenDateTimeWidget``
  511. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  512. .. class:: SplitHiddenDateTimeWidget
  513. Similar to :class:`SplitDateTimeWidget`, but uses :class:`HiddenInput` for
  514. both date and time.
  515. .. currentmodule:: django.forms.extras.widgets
  516. ``SelectDateWidget``
  517. ~~~~~~~~~~~~~~~~~~~~
  518. .. class:: SelectDateWidget
  519. Wrapper around three :class:`~django.forms.Select` widgets: one each for
  520. month, day, and year. Note that this widget lives in a separate file from
  521. the standard widgets.
  522. Takes one optional argument:
  523. .. attribute:: SelectDateWidget.years
  524. An optional list/tuple of years to use in the "year" select box.
  525. The default is a list containing the current year and the next 9 years.
  526. .. attribute:: SelectDateWidget.months
  527. .. versionadded:: 1.7
  528. An optional dict of months to use in the "months" select box.
  529. The keys of the dict correspond to the month number (1-indexed) and
  530. the values are the displayed months.
  531. .. code-block:: python
  532. MONTHS = {
  533. 1:_('jan'), 2:_('feb'), 3:_('mar'), 4:_('apr'),
  534. 5:_('may'), 6:_('jun'), 7:_('jul'), 8:_('aug'),
  535. 9:_('sep'), 10:_('oct'), 11:_('nov'), 12:_('dec')
  536. }
  537. .. attribute:: SelectDateWidget.empty_label
  538. .. versionadded:: 1.8
  539. If the :class:`~django.forms.DateField` is not required,
  540. :class:`SelectDateWidget` will have an empty choice at the top of the
  541. list (which is ``---`` by default). You can change the text of this
  542. label with the ``empty_label`` attribute. ``empty_label`` can be a
  543. ``string``, ``list``, or ``tuple``. When a string is used, all select
  544. boxes will each have an empty choice with this label. If ``empty_label``
  545. is a ``list`` or ``tuple`` of 3 string elements, the select boxes will
  546. have their own custom label. The labels should be in this order
  547. ``('year_label', 'month_label', 'day_label')``.
  548. .. code-block:: python
  549. # A custom empty label with string
  550. field1 = forms.DateField(widget=SelectDateWidget(empty_label="Nothing"))
  551. # A custom empty label with tuple
  552. field1 = forms.DateField(widget=SelectDateWidget(
  553. empty_label=("Choose Year", "Choose Month", "Choose Day"))