> 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/overlays/popup.md).

# Popup

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

## Overview

A customizable popup modal component that displays content in an overlay triggered by a button. Provides smooth animations, responsive behavior, and extensive styling options through block settings.

## Common use cases

* Use semantic HTML within popup content for better accessibility
* Keep popup content concise to avoid overwhelming users
* Consider mobile viewports when designing popup content
* Test keyboard navigation and screen reader compatibility
* Use appropriate color contrast for overlay background

## Compatible blocks

The following blocks can be nested within this block:

* [Container](/slab/content/blocks/layout/container.md) (for popup content)

## Block settings

### General

| Setting                | Description                                                                                      | Options                   |
| ---------------------- | ------------------------------------------------------------------------------------------------ | ------------------------- |
| Show advanced settings | Reveals close button, full background, colors, inheritance, margin, width, and device visibility | Checkbox (default: false) |

### Content

| Setting                | Description                                                             | Options                                                                                                                                                   |
| ---------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Overlay preset         | Select a preset overlay ID or use a custom one                          | <p>• Account<br>• Search<br>• Menu<br>• Primary cart<br>• Alternative cart<br>• Age verification<br>• Quick buy<br>• Quick edit<br>• Custom (default)</p> |
| Overlay ID             | Custom identifier for the overlay (used to trigger it programmatically) | <p>Text input<br><br>Visible when overlay preset is <strong>Custom</strong></p>                                                                           |
| Show close button      | Displays a close button in the popup                                    | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                        |
| Enable full background | Makes the popup background cover the entire viewport                    | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                        |

### Color

| Setting            | Description                                              | Options                                                                                                                                                                                                                                                                   |
| ------------------ | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type               | Custom scheme vs preset surface colors                   | <p>• Custom<br>• Base (default)</p><p><br><br>Visible when <strong>Show advanced settings</strong> is on and <strong>Enable inheritance</strong> is off</p>                                                                                                               |
| Color scheme       | Background and text pairing                              | <p>Color scheme picker<br><br>Visible when type is <strong>Custom</strong>, <strong>Show advanced settings</strong> is on, and <strong>Enable inheritance</strong> is off</p>                                                                                             |
| Color scheme       | Background and text pairing                              | <p>• Body background (default)<br>• Body foreground<br>• Accent 1–3<br>• Shade 1–3<br>• Blur<br>• Transparent</p><p><br><br>Visible when type is <strong>Base</strong>, <strong>Show advanced settings</strong> is on, and <strong>Enable inheritance</strong> is off</p> |
| Border color       | Popup border                                             | <p>• Subtle (default)<br>• Strong<br>• None</p><p><br><br>Visible when <strong>Show advanced settings</strong> is on, type is <strong>Base</strong>, and <strong>Enable inheritance</strong> is off</p>                                                                   |
| Enable inheritance | Inherit colors from the closest parent with a set scheme | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                                                                                                                                        |

### Layout

| Setting             | Description                       | Options                                                                                                                                                     |
| ------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Margin              | Outer margin around the popup     | <p>• Default<br>• Narrow<br>• Standard<br>• Wide<br>• Full<br>• None (default)</p><p><br><br>Visible when <strong>Show advanced settings</strong> is on</p> |
| Enable custom width | Enables a custom width percentage | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                          |
| Width               | Popup width                       | <p>0–100 % (default: 100 %)<br><br>Visible when <strong>Enable custom width</strong> and <strong>Show advanced settings</strong> are on</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/overlays/popup.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.