> For the complete documentation index, see [llms.txt](https://help.brickspacelab.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.brickspacelab.com/slab/content/blocks/navigation/search/search-results.md).

# Search results

<figure><img src="https://3723856256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGnixyIfIYFWroNtVmZo6%2Fuploads%2Fgit-blob-a45f263eab7a3fab339aa0e339b76304fd24dfe4%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

## Overview

A comprehensive search results block that provides real-time search functionality with keyboard navigation, suggestions, and displays results for multiple content types. Features a sticky search bar with input field, loading states, search suggestions, and organized results display for products, collections, pages, articles, and query suggestions.

## Common use cases

* Configure search resource types in theme settings to control what content appears in results
* Add manual search link suggestions to help users discover content when starting their search
* Use appropriate color schemes and border styles to match your theme design
* Consider the number of search result types when configuring the layout
* Set up customer access tags if you need to hide certain content from non-approved users
* Ensure Alpine.js search store and helper functions are properly initialized
* Test keyboard navigation functionality across different devices and browsers

## Block settings

### General

| Setting                | Description                 | Options                   |
| ---------------------- | --------------------------- | ------------------------- |
| Show advanced settings | Reveals visibility settings | Checkbox (default: false) |

### Content

| Setting                | Description                                                                      | Options                                  |
| ---------------------- | -------------------------------------------------------------------------------- | ---------------------------------------- |
| Placeholder            | Placeholder text for the search input                                            | Text input (default: Search for product) |
| Search recommendations | Link list of manual search suggestions to display when no search term is entered | Link list picker                         |

### Spacing

| Setting                   | Description                                       | Options                   |
| ------------------------- | ------------------------------------------------- | ------------------------- |
| Enable horizontal padding | Adds horizontal padding around the search results | Checkbox (default: false) |
| Enable top padding        | Adds top padding around the search results        | Checkbox (default: false) |
| Enable bottom padding     | Adds bottom padding around the search results     | Checkbox (default: false) |

### Color

| Setting      | Description                                        | Options                                                                                                                                                                                    |
| ------------ | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Color scheme | Controls the background and text color combination | <p>• Body<br>• Neutral<br>• Accent 1 (default)<br>• Accent 2<br>• Accent 3<br>• Shade 1<br>• Shade 2<br>• Shade 3<br>• Primary<br>• Secondary<br>• Tertiary<br>• Blur<br>• Transparent</p> |
| Border color | Controls the border color                          | <p>• Body<br>• Subtle (default)<br>• Strong<br>• Primary<br>• Secondary<br>• Tertiary<br>• None</p>                                                                                        |

### Display

| Setting    | Description                        | Options                                                                                                                            |
| ---------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Visibility | Controls when the block is visible | <p>• All (default)<br>• Mobile only<br>• Desktop only</p><p><br><br>Visible when <strong>Show advanced settings</strong> is on</p> |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.brickspacelab.com/slab/content/blocks/navigation/search/search-results.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.