Skip to content

Sheet ​

Extends the Dialog to display content that complements the main content of the screen.

Usage ​

Approximate web preview — the HarmonyOS rendering is the reference.

API ​

Extracted from the @Param / @Event / @BuilderParam declarations in the library sources.

SSheet ​

shadcn-vue Sheet: a dialog that slides in from an edge.

PropTypeDefaultDescription
open!!boolean | undefinedundefined
defaultOpenbooleanfalse
EventTypeDefaultDescription
onOpenChange(open: boolean) => void() => { }

Slots: children (trailing closure)

SSheetTrigger ​

Slots: children (trailing closure)

SSheetClose ​

Slots: children (trailing closure)

SSheetContent ​

Edge panel: bg-background shadow-lg, left/right w-3/4 sm:max-w-sm, slides in from side.

PropTypeDefaultDescription
sideSheetSide
SheetSide = 'top' | 'right' | 'bottom' | 'left'
'right'
showCloseButtonbooleantrue
dismissOnOutsidebooleantrue
panelWidthnumber0Width for left/right sheets in vp (default: 75% of the window, max 384).
tokensSparkSurfaceTokens{}Per-instance surface token overrides (instance → theme tokens → recipe), see {@link SparkSurfaceTokens}.

Slots: children (trailing closure)

SSheetHeader ​

Slots: children (trailing closure)

SSheetFooter ​

Actions area. In left / right sheets it is pushed to the bottom (shadcn mt-auto).

Slots: children (trailing closure)

SSheetTitle ​

PropTypeDefaultDescription
textResourceStr''

SSheetDescription ​

PropTypeDefaultDescription
textResourceStr''

MIT Licensed