Skip to content

Commit

Permalink
Merge pull request #590 from azmeuk/html5-widgets-doc
Browse files Browse the repository at this point in the history
Document HTML5 widgets
  • Loading branch information
azmeuk committed Apr 24, 2020
2 parents aa552df + 4536cb1 commit bd03955
Showing 1 changed file with 31 additions and 13 deletions.
44 changes: 31 additions & 13 deletions docs/widgets.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Widgets
=======
.. module:: wtforms.widgets

Widgets are classes whose purpose are to render a field to its usable
representation, usually XHTML. When a field is called, the default behaviour
Expand All @@ -15,17 +14,36 @@ recognize as not needing to be auto-escaped.
Built-in widgets
----------------

.. autoclass:: ListWidget
.. autoclass:: TableWidget
.. autoclass:: Input
.. autoclass:: TextInput()
.. autoclass:: PasswordInput
.. autoclass:: HiddenInput()
.. autoclass:: CheckboxInput()
.. autoclass:: FileInput()
.. autoclass:: SubmitInput()
.. autoclass:: TextArea
.. autoclass:: Select
.. autoclass:: wtforms.widgets.ListWidget
.. autoclass:: wtforms.widgets.TableWidget
.. autoclass:: wtforms.widgets.Input
.. autoclass:: wtforms.widgets.TextInput()
.. autoclass:: wtforms.widgets.PasswordInput
.. autoclass:: wtforms.widgets.HiddenInput()
.. autoclass:: wtforms.widgets.CheckboxInput()
.. autoclass:: wtforms.widgets.FileInput()
.. autoclass:: wtforms.widgets.SubmitInput()
.. autoclass:: wtforms.widgets.TextArea
.. autoclass:: wtforms.widgets.Select

HTML5 widgets
-------------

.. module:: wtforms.widgets.html5

.. autoclass:: wtforms.widgets.html5.ColorInput
.. autoclass:: wtforms.widgets.html5.DateTimeInput
.. autoclass:: wtforms.widgets.html5.DateTimeLocalInput
.. autoclass:: wtforms.widgets.html5.DateInput
.. autoclass:: wtforms.widgets.html5.EmailInput
.. autoclass:: wtforms.widgets.html5.MonthInput
.. autoclass:: wtforms.widgets.html5.NumberInput
.. autoclass:: wtforms.widgets.html5.RangeInput
.. autoclass:: wtforms.widgets.html5.SearchInput
.. autoclass:: wtforms.widgets.html5.TelInput
.. autoclass:: wtforms.widgets.html5.TimeInput
.. autoclass:: wtforms.widgets.html5.URLInput
.. autoclass:: wtforms.widgets.html5.WeekInput

Widget-Building Utilities
-------------------------
Expand All @@ -34,7 +52,7 @@ These utilities are used in WTForms widgets to help render HTML and also in
order to work along with HTML templating frameworks. They can be imported for
use in building custom widgets as well.

.. autofunction:: html_params
.. autofunction:: wtforms.widgets.html_params

WTForms uses `MarkupSafe`_ to escape unsafe HTML characters before
rendering. You can mark a string using :class:`markupsafe.Markup` to
Expand Down

0 comments on commit bd03955

Please sign in to comment.