> For the complete documentation index, see [llms.txt](https://docs.jetadmin.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jetadmin.io/classic-app-builder/design-and-structure/components/modal.md).

# Modals and overlays

Applies to **Classic App Builder**. A modal displays content above the current page; a slideout opens from the side, and a dropdown opens near its trigger. Use a modal to show record details or a form without navigating away.

This guide uses the existing Classic interface and media. For AI App Builder, use [focused edits in Preview](/ai-app-builder/refine-an-app.md).

## Before you start

Have a Classic page with a table and a resource containing a unique record identifier, such as Product ID. Use test records to check your bindings before adding write actions.

## Create a modal

1. Open **Overlays** in the builder's top bar.
2. Select **+** beside the modal option. In earlier Classic layouts, drag **modal** or **slideout** from the component sidebar onto the page.
3. Open the overlay and add the components it needs: a Detail component for viewing a record, or inputs for a form.
4. Configure its title, width, and display style. A title can be static or use a dynamic value.
5. Close the overlay editor to return to the page. Reopen it through **Overlays** when you need to edit it.

![Earlier Classic sidebar with modal and slideout components](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml8zvhKJwyAnCOLVjcY%2F-Ml98B58mfQJRgpbBI9p%2Ftestgif98.gif?alt=media\&token=9a3dfbf8-1cd5-4c93-9f9a-9760d3dc77a2)

![Overlays entry point in the Classic builder](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LQ08RFAKZvFADEiXKFy%2Fuploads%2F1ozMZsAV8PFFGaFuI0gy%2Fimage.png?alt=media\&token=d5deeea8-359f-4aa0-8b06-a2f4c0d6209d)

For the creation walkthrough and display options, see [Overlay layouts](/classic-app-builder/design-and-structure/components/layouts/overlays.md) and [Customize an overlay](/classic-app-builder/design-and-structure/components/layouts/overlays/customizing-overlay.md).

## Open a modal when a table row is clicked

1. Select the table on the page.
2. Configure its **Row click** action.
3. Choose **Open Overlay** and select the modal you created.
4. Add a **Detail** component inside that modal and select the relevant resource.
5. Filter the Detail component by the record's primary key, binding the filter value to the selected table row's primary key.

For example: the table's selected Product ID is 42, so the Detail component must load the product whose ID equals 42. A matching name is not a substitute for a unique identifier.

![Classic table Row click action configured to Open Overlay](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9TdsgNGU7RtKLf1cJ%2Ftestgif102.gif?alt=media\&token=62be4eca-12a3-427a-820d-7590cfedebcc)

![Selecting the target overlay in the Classic action settings](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9U8bhCsbqU8SQFBa0%2Ftestgif103.gif?alt=media\&token=8945611c-c031-43a4-90fb-8075748367d6)

![Detail component added inside a Classic overlay](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9UZ89os3XY_Wr0lNn%2Ftestgif104.gif?alt=media\&token=9eb4b72d-eef4-49fc-be13-4479f2655dbb)

![Filtering record details using the selected row's primary key](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9UqRLRVXiPnQD7ZCk%2Ftestgif105.gif?alt=media\&token=14a55937-afaa-4cbd-9d67-6cb7e99cd420)

**Expected result:** clicking a row opens the modal with that record's details. To show details only after a click, place the Detail component inside the modal rather than permanently beside the table.

## Open a modal from a button

Select the button, configure its action as **Open Overlay**, and choose the target modal. See [Configure a button action](/classic-app-builder/classic-tutorials/configure-a-button-action.md).

For a button that depends on a selected row, ensure a row is selected before opening the modal. Pass the selected record identifier to the overlay and use it to load the intended record.

## Pass values into a modal or form

Use [Overlay Parameters](/classic-app-builder/design-and-structure/components/layouts/overlays/overlay-parameters.md) to pass contextual values from the page. Create a parameter of the appropriate type, supply its value in the action that opens the overlay, and bind the receiving component to it.

For a record-specific form, distinguish the identifier used to choose the record from editable input values. Opening the modal is not the same as submitting the form or updating the record.

See [Bind page data to a modal](/classic-app-builder/binding-and-values/binding-across-overlays.md) for a worked example and the retained Classic video.

## Verify the result

1. Open record A and confirm its identifier and details.
2. Close the modal, then open record B and confirm the displayed data changes.
3. Check a row with an empty optional field.
4. For button-triggered overlays, check the behavior before a row is selected.
5. If you added a save action, test it separately with a synthetic record and verify the intended record changed.

Test with the intended user's permissions. A modal or hidden component does not itself enforce data access.

## Troubleshooting

| Problem                              | Check                                                                            |
| ------------------------------------ | -------------------------------------------------------------------------------- |
| Modal does not open                  | The trigger has an Open Overlay action and the correct target                    |
| A page opens instead                 | The trigger is configured for an overlay, not page navigation                    |
| Wrong record appears                 | The receiving component filters by the selected row's unique identifier          |
| Data stays the same between rows     | The parameter or filter is bound dynamically rather than to a copied fixed value |
| Details appear before clicking       | The Detail component is on the page instead of inside the overlay                |
| Modal opens but contains no data     | Resource, identifier type, empty selection, and user permissions                 |
| Form opens but changes are not saved | Opening and submitting are separate actions; inspect the form's submit action    |

## Customize the appearance

![Classic overlay width settings](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9F5anH1jauxBvSu79%2Ftestgif99.gif?alt=media\&token=2f539819-1611-4594-bac1-f52356f4ce2c)

![Classic overlay display styles](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9FWJyTF2J02NjXzLa%2Ftestgif100.gif?alt=media\&token=83dddcbf-dc08-41e0-84a4-cf528939e9ce)

![Classic overlay title configuration](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml99EbDLSj5K1c2poMn%2F-Ml9GAwkZeRg0Rvn5ML5%2Ftestgif101.gif?alt=media\&token=24f52c6c-c3ca-4b4d-9c94-c0b6ea0a8bd7)

For dynamic titles, see [Formulas](/user-guide/data/computed-fields/formulas.md).

![Example of an overlay in an earlier Classic app](https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ08RFAKZvFADEiXKFy%2F-Ml8zvhKJwyAnCOLVjcY%2F-Ml978cHRXfoe6zZKzk_%2Ftestgif97.gif?alt=media\&token=de4bb6e0-d198-484b-bab7-414c923a85c9)

Screenshots are retained Classic reference media. The workflow was not re-executed in a Classic test app during this editorial update.


---

# 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.jetadmin.io/classic-app-builder/design-and-structure/components/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.