Search

<search>: The generic search element #

::: section-content The <search> HTML element is a container representing the parts of the document or application with form controls or other content related to performing a search or filtering operation. The <search> element semantically identifies the purpose of the element's contents as having search or filtering capabilities. The search or filtering functionality can be for the website or application, the current web page or document, or the entire Internet or subsection thereof. :::

Attributes #

::: section-content This element only includes the global attributes. :::

Usage notes #

::: section-content The <search> element is not for presenting search results. Rather, search or filtered results should be presented as part of the main content of that web page. That said, suggestions and links that are part of "quick search" functionality within the search or filtering functionality are appropriately nested within the contents of the <search> element as they are search features. :::

Accessibility #

::: section-content The <search> element defines a search landmark. This removes the need for adding role=search to a <form> element. :::

Examples #

Header search form #

::: section-content This example demonstrates the use of <search> as the container for a search within a website header to perform a simple site-wide search. The <search> is a semantic container for the <form> that submits the user-entered search query to a server.

HTML #

::: code-example [html]{.language-name}

<header>
  <h1>Movie website</h1>
  <search>
    <form action="./search/">
      <label for="movie">Find a Movie</label>
      <input type="search" id="movie" name="q" />
      <button type="submit">Search</button>
    </form>
  </search>
</header>

:::

Result #

::: {#sect1 .code-example} ::: iframe ::: ::: :::

::: section-content This example demonstrates potential DOM content when dynamically including JavaScript search functionality in a web application. When search functionality is implemented entirely with JavaScript, if no form is submitted, neither a <form> element nor a submit <button> is required. For semantics, the <search> element is included to contain the search and filtering capabilities.

HTML #

::: code-example [html]{.language-name}

<search>
  <label>
    Find and filter your query
    <input type="search" id="query" />
  </label>
  <label>
    <input type="checkbox" id="exact-only" />
    Exact matches only
  </label>

  <section>
    <h3>Results:</h3>
    <ul id="results">
      <!-- search result content -->
    </ul>
    <output id="no-results">
      <!-- no results content -->
    </output>
  </section>
</search>

:::

Result #

::: {#sect2 .code-example} ::: iframe ::: :::

::: {#sect3 .notecard .note} Note: Remember that some users don't have JavaScript, and none of your users have JavaScript running until the JavaScript is successfully downloaded, parsed, and executed, ensure your users can access the content of your site with JavaScript disabled. ::: :::

Multiple searches #

::: section-content This example demonstrates a page with two search features. The first is a global site search located on the header. The second is a search and filter based on the page context, in our example a car search.

HTML #

::: code-example [html]{.language-name}

<body>
  <header>
    <h1>Car rental agency</h1>
    <search title="Website">...</search>
  </header>
  <main>
    <h2>Cars available for rent</h2>
    <search title="Cars">
      <h3>Filter results</h3>
      ...
    </search>
    <article>
      <!-- search result content -->
    </article>
  </main>
</body>

:::

Result #

::: {#sect4 .code-example} ::: iframe ::: ::: :::

Technical summary #

::: section-content

Content categoriesFlow content, palpable content.
Permitted contentFlow content.
Tag omissionNone, both the starting and ending tag are mandatory.
Implicit ARIA rolesearch
Permitted ARIA rolesform, group, none, presentation, region, search
DOM interfaceHTMLElement
:::

Specifications #

::: _table #

Specification #

HTML Standard
[# the-search-element]{.small}

:::

Browser compatibility #

::: _table Desktop Mobile

         Chrome    Edge   Firefox   Internet Explorer   Opera   Safari   WebView Android   Chrome Android   Firefox for Android   Opera Android   Safari on IOS   Samsung Internet

search 118 118 118 No 104 17 118 118 118 No 17 No :::

See also #

::: section-content

::: _attribution © 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search{._attribution-link} :::

Calendar December 2, 2023
Edit Edit this page