Skip to content
UI
On this page

Sheet

Shows a modal panel at a viewport edge.

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 field visit sheet

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 SheetTrigger and SheetPopup inside Sheet, with SheetTitle, SheetDescription and SheetPanel in the popup.

side selects the viewport edge. SheetPopup includes the portal, backdrop, viewport, and an optional close button. Use frameTitle for an optional frame caption. SheetTitle gives the dialog its accessible name. Use Drawer if swipe gestures are required.

Use surfaceXstyle to change the inner Sheet surface. Mobile Sidebar uses this slot to keep one flat surface.

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