> ## Documentation Index
> Fetch the complete documentation index at: https://help.standards.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Search

Search lets viewers find pages, content, files, and colors across your published guideline from a single search field.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-hero.gif?s=9dde82e7ed31e25d98d62998afd2cc07" alt="Search Hero" width="1270" height="716" data-path="images/search-hero.gif" />
</Frame>

***

## Search indexing

Standards automatically indexes the visible content of your published site:

* **Pages**: page names, plus a summary of the content on the page
* **Sections**: each section of a page, with its name taken from the heading that leads it
* **Files**: file names and their descriptions, classified by type (documents, images, fonts, archives, motion, audio)
* **Colors**: color names and values from swatches

To improve results, give pages clear names and descriptions, tag headings with the correct [content tags](/accessibility), and add [descriptions to your files](/accessibility).

The index is rebuilt when you publish, and the previous index stays in place until the new one is ready, so search keeps working throughout. Indexing runs per language, so each [localized](/localization) version of your site is searched in its own language.

<Info>
  **Access control:** Content that a viewer can't access, such as password-protected or sign-in–gated pages, is not surfaced to them in search results. Access is checked at search time, so changing a page's protection takes effect without republishing.
</Info>

***

## Adding search

There are two ways to add search to a site: Add a **Search menu**, or place a [search element](/search-element) directly onto a page. Both use the same indexed content.

### Search menu

A Search menu is a [menu](/menus) that contains a search element and displays results. Add one the same way you add any menu, choosing a search-style starting point.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-menu.png?fit=max&auto=format&n=eseM9UR4fUkc6IS3&q=85&s=21513da0cde3f1b6498eed8494ff7f55" alt="Search Menu" width="1200" height="600" data-path="images/search-menu.png" />
</Frame>

<Steps>
  <Step title="Select the Menu tab">
    Within the editor, select the **Menu** tab from the left sidebar.
  </Step>

  <Step title="Add a new menu">
    Select **New menu**. A project can contain multiple menus, so a Search menu can be added alongside an existing navigation menu.
  </Step>

  <Step title="Choose Search as the function">
    In the **New menu** window, choose **Search** under **Function**. (The other functions are **Navigation** and **Custom**. See [Menus](/menus#function).)
  </Step>

  <Step title="Choose a layout and type">
    Pick where the menu sits and which take on it to use:

    * **Overlay**: **Small** or **Large** (a centered panel with a single- or multi-column results layout), or **Full screen** (a search takeover)
    * **Sidebar**: **Open & close** or **Persistent**
    * **Top bar**: **Small** or **Large**
  </Step>

  <Step title="Choose a style and color, then add">
    Pick a **Style** (Default, Rounded, or Translucent) and a **Color** (Light or Dark), check the live preview, then select **Add**.
  </Step>
</Steps>

All of these are the same element with different settings applied, so you can adjust the layout and styling at any time. See [Menus](/menus#adding-a-menu) for the full add flow.

<Info>
  **Tip:** A common pattern is to add a [button](/button) anywhere in your project that opens the Search menu with an **Open & close** [click behavior](/click-hover). This lets viewers trigger search from a nav bar, a header, or any element you choose.
</Info>

### Search element

The Search element places a search field and its results directly onto a page, rather than inside a [menu](/menus). It's the same search experience, positioned within your page layout.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-element.png?fit=max&auto=format&n=eseM9UR4fUkc6IS3&q=85&s=94fc64faf5e62840a0b806472eb351f8" alt="Search Element" width="1200" height="600" data-path="images/search-element.png" />
</Frame>

<Steps>
  <Step title="Choose the add tool">
    From within the editor, open the **+** menu and choose **Search**.
  </Step>

  <Step title="Place it on the page">
    Select the add point where you want the element to sit within your page layout.
  </Step>

  <Step title="Style it">
    Select the element and its inner parts (**Input**, **Results**, result rows) and adjust their settings in the right sidebar as you would any other element.
  </Step>
</Steps>

<Info>
  **In the editor:** The search field shows **example placeholder results** so you can design and style it. Real results come from your published content. Try search on the live or preview site to see it working.
</Info>

***

## Search states

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-states.png?fit=max&auto=format&n=eseM9UR4fUkc6IS3&q=85&s=4339cacce3598f399414077b4e134bed" alt="Search States" width="1200" height="600" data-path="images/search-states.png" />
</Frame>

The search elements have [States](/element-states) you can style individually:

* **Search**: **Rest** and **Searching** (while a search is active)
* **Search input**: **Rest**, **Hover**, **Loading**, **Focused**, and **Focused / Hover**
* **Result** rows: **Rest** and **Hover**

Select the relevant element and open the state editor to style each state.

***

## Anatomy

The Search element is made up of a few native parts you can select and style individually:

* **Input**: the field viewers type into
* **Results**: the area that displays matches, which contains:
  * **Count**: a summary of how many results were found
  * **Result rows**: each with a **Thumbnail**, a **Title**, and **Details** (metadata about the result, such as its page, file type, dimensions, or color values, depending on the kind of result)

***

## Result thumbnails and details

Each result row holds a **thumbnail**, **title**, and a **details** element, and both are configured per result category.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-result-content.png?fit=max&auto=format&n=eseM9UR4fUkc6IS3&q=85&s=a37459858c7651cc8ffe16700ad5eeb7" alt="Search Result Content" width="1200" height="600" data-path="images/search-result-content.png" />
</Frame>

### Thumbnail formats

A thumbnail's appearance is set per category, which the sidebar calls its **Format** (Page, Section, Document, Image, Font, Archive, Motion, Audio, Color, and File as the catch-all for anything else). Select a thumbnail and use **Edit formats** to style each one.

* **Icon**: each format has its own default icon glyph, which you can swap. **Icon color** and **Icon scale** are under **Fill**.
* **Preview**: when on, the thumbnail renders the result's real content instead of an icon — the color's swatch, the image file, sample glyphs in the font's own face, or a scaled live render of the page or section. Each format toggles this independently.

Sizing, fills, strokes, and corner radius are shared across all formats, so the thumbnail keeps one shape whatever it's showing.

### Title fields

A result's **Title** can show the entry's **Name**, its **Description** (the indexed body text), or both, toggled per category. A section's name is its heading, so its description is on by default there to make the result readable; elsewhere the name leads on its own.

### Details fields

The **Details** element lists metadata beneath a result's title, with the available fields depending on the category. Toggle fields on and off per category:

* **Page**: name, URL
* **Section**: page, section name, URL
* **Images**: file type, dimensions, file size
* **Fonts**: file type, family, weight
* **Documents** and **Archives**: file type, file size
* **Motion** and **Audio**: file type, duration, dimensions, file size
* **Colors**: HEX, RGB, CMYK, PMS, PMS 2, RAL

Fields with no value for a given result are skipped, so rows never show empty gaps.

***

## Choosing what results appear

The search area's settings control which content search draws from. Select the **Search** element and open its **Settings** from the contextual toolbar.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-scope.png?fit=max&auto=format&n=eseM9UR4fUkc6IS3&q=85&s=0012a98f800f9edfddecb43a6c126604" alt="Search Scope" width="1200" height="600" data-path="images/search-scope.png" />
</Frame>

<Info>
  **In the editor:** The element shows **example placeholder results** so you can design and style it. Real results come from your published content. Try search on the live or preview site to see it working.
</Info>

### Pages

* **All pages**: search everything on the site
* **This page**: only search content on the page the search sits on
* **Choose pages**: search only the pages you select

### Categories

* **All categories**: return every kind of result
* **Choose categories**: return only the categories you select — **Pages**, **Sections**, **Documents**, **Images**, **Fonts**, and **Archives**

<Info>
  **Tip:** Narrowing the categories is a good way to build a purpose-built search, such as a downloads page that only returns files.
</Info>

***

## Open over content

The search element has the option to either push content below it down when results expand, or open over content so nothing else on the page moves when the results expand. Simple toggle the setting from the settings section of the contextual tools.

<Frame>
  <img src="https://mintcdn.com/standards/eseM9UR4fUkc6IS3/images/search-open-over-content.gif?s=da967a138cdd5f0405f54a7ca184ff2d" alt="Search Open Over Content" width="1622" height="912" data-path="images/search-open-over-content.gif" />
</Frame>

<Steps>
  <Step title="Select the search element">
    From within the body or from the left sidebar, select the **search** element
  </Step>

  <Step title="Select settings">
    Select the settings button from the contextual tools that show beside the **search** element in body
  </Step>

  <Step title="Toggle open over content">
    Select the open over content toggle to enable and disable
  </Step>
</Steps>
