Blackwork
Scroll to top

Sheet

A sliding panel for navigation, filters, or an inspector.

Sheet

When to use

  • Mobile navigation
  • Filters that should stay on screen
  • Inspect or edit an item while the list stays visible

Use Dialog for a short confirmation in the center of the page.

Usage

Usage

Sides

Sides

API Reference

PropTypeDefaultDescription
side"top" | "right" | "bottom" | "left""right"Edge the panel slides from. Set on SheetContent.
closeButtonVisiblebooleantrueCorner close button on SheetContent. Set false when you provide your own.
asChildbooleanfalseOn SheetTrigger and SheetClose. Requires a button child.
openbooleanControlled open state on Sheet.
onOpenChange(open: boolean) => voidCalled when the sheet opens or closes.

Notes

  • Default side is right.
  • Set closeButtonVisible={false} only when you render your own close control.
  • Same asChild rule as Dialog: the trigger child must be a button.