> For the complete documentation index, see [llms.txt](https://docs.avonnicomponents.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avonnicomponents.com/dynamic-components/component-builder/interactions/open-alert-modal.md).

# Open Alert Modal

The Open Alert Modal interaction displays an important message in a modal dialog that the user must acknowledge before continuing.

## Overview

The Open Alert Modal interaction displays essential information to the user within a modal window. This is a way to notify users about critical updates, potential issues, or required actions.

### **When to Use Alert Modals**

Use an alert modal for these types of messages:

* **Neutral/General Information:** Notify users of changes or updates.
* **Warning:** Deliver critical information to help users avoid problems.
* **Error:** Inform users of critical errors that block progress and require action to resolve

<figure><img src="https://docs.avonnicomponents.com/~gitbook/image?url=https%3A%2F%2F27923732-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1FUd4apB9YHgCEMUFbVb%252Fuploads%252FyMB9ghRkmIdJR4FJXGeU%252F2022-11-03_21-26-21.png%3Falt%3Dmedia%26token%3D0d1be44d-fb56-4060-83f9-67ab8f086e54&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=4c3aa346&#x26;sv=2" alt=""><figcaption></figcaption></figure>

## Configuration

### Accessing the Alert Modal action

| Label    | The text displayed in the modal's header.                                                         | Any text string.                                                                                                           |
| -------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Message  | The main content message displayed in the alert modal.                                            | Any text string.                                                                                                           |
| Variant  | Determines the appearance of the alert modal. Controls whether the header is displayed.           | With Header, Without Header (or similar, depending on your actual implementation)                                          |
| Theme    | Sets the color theme for the header (if a header is displayed).                                   | Default, Shade, Inverse, Alt Inverse, Success, Info, Warning, Error, Offline                                               |
| On Close | Allows you to define a subsequent interaction that triggers when the user closes the alert modal. | This likely refers to configuring another interaction (e.g., Navigate, Show Toast, etc.). This is not a simple text value. |

<br>


---

# 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://docs.avonnicomponents.com/dynamic-components/component-builder/interactions/open-alert-modal.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.