Use the new HTML <search> element (#11704)

sphinx-doc · Oct 4, 2023 · fb1e521 · fb1e521
1 parent 5730329
commit fb1e521
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -17,6 +17,11 @@ Deprecated
 Features added
 --------------
 
+* #11701: HTML Search: Adopt the new `<search>`_ element.
+  Patch by Bénédikt Tran.
+
+  .. _`<search>`: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search
+
 Bugs fixed
 ----------
 

diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html
@@ -39,13 +39,13 @@ <h3>{{ _('Table of Contents') }}</h3>
           {{ toctree(includehidden=True) }}
           {%- endblock %}
           {%- block sidebarsearch %}
-          <div role="search">
+          <search role="search">
             <h3 style="margin-top: 1.5em;">{{ _('Search') }}</h3>
             <form class="search" action="{{ pathto('search') }}" method="get">
                 <input type="text" name="q" />
                 <input type="submit" value="{{ _('Go') }}" />
             </form>
-          </div>
+          </search>
           {%- endblock %}
 {% endmacro %}
 

diff --git a/sphinx/themes/basic/searchbox.html b/sphinx/themes/basic/searchbox.html
@@ -8,14 +8,14 @@
     :license: BSD, see LICENSE for details.
 #}
 {%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">{{ _('Quick search') }}</h3>
     <div class="searchformwrapper">
     <form class="search" action="{{ pathto('search') }}" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="{{ _('Go') }}" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
 {%- endif %}
diff --git a/sphinx/themes/basic/searchfield.html b/sphinx/themes/basic/searchfield.html
@@ -11,13 +11,13 @@
     :license: BSD, see LICENSE for details.
 #}
 {%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
     <div class="searchformwrapper">
     <form class="search" action="{{ pathto('search') }}" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
       <input type="submit" value="{{ _('Go') }}" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
 {%- endif %}