About Dashboard Modals

A dashboard modal is a dialog that opens over a dashboard page. This reference is the contract for a modal you add as an extension: the generated files, the configuration object, the shared config, and the React component that renders when the modal is open.

The file set and configuration object are the same whether you add the modal in a Studio Two site project or in a Wix CLI app.

What's in this reference

• Dashboard Modal Extension Files and Code: The generated file set, the extensions.dashboardModal() configuration fields, the shared config, and what you can use inside the modal component.

To open the modal from a dashboard page or another dashboard surface, call openModal() from the Dashboard SDK. Pass the modal ID from the configuration file. Inside the modal, call closeModal() to dismiss it. You can pass data back to the opener when the modal closes. For data sent into the modal, use observeState().

See also

• Dashboard Modals
• Dashboard Modal Extension Files and Code
• openModal()
• closeModal()
• observeState()