Browse Source

Fixed #35598 -- Added SearchInput widget.

Jeremy Thompson 8 months ago
parent
commit
30a60e8492

+ 1 - 0
AUTHORS

@@ -495,6 +495,7 @@ answer newbie questions, and generally made Django that much better:
     Jeremy Carbaugh <jcarbaugh@gmail.com>
     Jeremy Dunck <jdunck@gmail.com>
     Jeremy Lainé <jeremy.laine@m4x.org>
+    Jeremy Thompson <https://jhthompson.ca>
     Jerin Peter George <jerinpetergeorge@gmail.com>
     Jesse Young <adunar@gmail.com>
     Jezeniel Zapanta <jezeniel.zapanta@gmail.com>

+ 1 - 0
django/forms/jinja2/django/forms/widgets/search.html

@@ -0,0 +1 @@
+{% include "django/forms/widgets/input.html" %}

+ 1 - 0
django/forms/templates/django/forms/widgets/search.html

@@ -0,0 +1 @@
+{% include "django/forms/widgets/input.html" %}

+ 6 - 0
django/forms/widgets.py

@@ -30,6 +30,7 @@ __all__ = (
     "NumberInput",
     "EmailInput",
     "URLInput",
+    "SearchInput",
     "PasswordInput",
     "HiddenInput",
     "MultipleHiddenInput",
@@ -353,6 +354,11 @@ class URLInput(Input):
     template_name = "django/forms/widgets/url.html"
 
 
+class SearchInput(Input):
+    input_type = "search"
+    template_name = "django/forms/widgets/search.html"
+
+
 class PasswordInput(Input):
     input_type = "password"
     template_name = "django/forms/widgets/password.html"

+ 11 - 0
docs/ref/forms/widgets.txt

@@ -558,6 +558,17 @@ These widgets make use of the HTML elements ``input`` and ``textarea``.
     * ``template_name``: ``'django/forms/widgets/url.html'``
     * Renders as: ``<input type="url" ...>``
 
+``SearchInput``
+~~~~~~~~~~~~~~~
+
+.. versionadded:: 5.2
+
+.. class:: SearchInput
+
+    * ``input_type``: ``'search'``
+    * ``template_name``: ``'django/forms/widgets/search.html'``
+    * Renders as: ``<input type="search" ...>``
+
 ``PasswordInput``
 ~~~~~~~~~~~~~~~~~
 

+ 2 - 1
docs/releases/5.2.txt

@@ -165,7 +165,8 @@ File Uploads
 Forms
 ~~~~~
 
-* ...
+* The new :class:`~django.forms.SearchInput` form widget is for entering search
+  queries and renders as ``<input type="search" ...>``.
 
 Generic Views
 ~~~~~~~~~~~~~

+ 12 - 0
tests/forms_tests/widget_tests/test_searchinput.py

@@ -0,0 +1,12 @@
+from django.forms import SearchInput
+
+from .base import WidgetTest
+
+
+class SearchInputTest(WidgetTest):
+    widget = SearchInput()
+
+    def test_render(self):
+        self.check_html(
+            self.widget, "search", "", html='<input type="search" name="search">'
+        )