summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/forms/widgets.txt15
-rw-r--r--docs/releases/3.1.txt3
2 files changed, 13 insertions, 5 deletions
diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt
index a9c442289c..e986154753 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -325,17 +325,22 @@ foundation for custom widgets.
to display the ``required`` attribute for each field.
By default, returns ``False`` for hidden widgets and ``True``
- otherwise. Special cases are :class:`~django.forms.ClearableFileInput`,
- which returns ``False`` when ``initial`` is set, and
- :class:`~django.forms.CheckboxSelectMultiple`, which always returns
- ``False`` because browser validation would require all checkboxes to be
- checked instead of at least one.
+ otherwise. Special cases are :class:`~django.forms.FileInput` and
+ :class:`~django.forms.ClearableFileInput`, which return ``False`` when
+ ``initial`` is set, and :class:`~django.forms.CheckboxSelectMultiple`,
+ which always returns ``False`` because browser validation would require
+ all checkboxes to be checked instead of at least one.
Override this method in custom widgets that aren't compatible with
browser validation. For example, a WSYSIWG text editor widget backed by
a hidden ``textarea`` element may want to always return ``False`` to
avoid browser validation on the hidden field.
+ .. versionchanged:: 3.1
+
+ In older versions, ``True`` was returned for
+ :class:`~django.forms.FileInput` when ``initial`` was set.
+
``MultiWidget``
---------------
diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt
index ffffdc0d1b..cdacbd71cd 100644
--- a/docs/releases/3.1.txt
+++ b/docs/releases/3.1.txt
@@ -406,6 +406,9 @@ Miscellaneous
* Date-only formats are removed from the default list for
:setting:`DATETIME_INPUT_FORMATS`.
+* The :class:`~django.forms.FileInput` widget no longer renders with the
+ ``required`` HTML attribute when initial data exists.
+
.. _deprecated-features-3.1:
Features deprecated in 3.1