Skip to content
UI
On this page

Dialog

Provides a modal dialog with an optional scrolling panel and mobile layout.

Overview

Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.

Preview

Edit reservation form

Installation

Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.

Usage

Compose DialogTrigger and DialogPopup inside Dialog. Give the popup a DialogTitle and, when useful, DialogDescription.

DialogPopup includes its portal, backdrop, viewport, and optional close button. Use frameTitle for a visual caption, not the accessible title. DialogPanel provides a scrolling content region. DialogContent is an alias for DialogPopup. DialogOverlay is an alias for DialogBackdrop.

Import from the local file installed by the CLI.

API reference

The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.

View API reference