Sheet

A side panel component that slides in from the screen edge. Perfect for navigation menus, filter panels, settings drawers, and detail views.

Edit profile

Make changes to your profile here. Click save when you're done.

Installation

CLI

Install the component using the StarUI CLI:

star add sheet

Examples

Side

Sheets sliding from all four screen edges

Top sheet

This sheet slides in from the top edge.

Right sheet

This sheet slides in from the right edge.

Bottom sheet

This sheet slides in from the bottom edge.

Left sheet

This sheet slides in from the left edge.

Sizes

Width variants from small to extra large

Small Sheet

Compact size for simple content

This is a small sheet (max-w-sm) — perfect for simple forms and quick actions.

Medium Sheet

Standard size for most content

This is a medium sheet (max-w-md) — the default size for forms and settings.

Large Sheet

More space for complex content

This is a large sheet (max-w-lg) — great for detailed forms and data views.

Extra Large Sheet

Maximum width for extensive content

This is an extra large sheet (max-w-xl) — ideal for dashboards and data tables.

No Close Button

Custom close with show_close=False

Custom close

This sheet hides the default close button. Use the button below to dismiss.

Notifications

Per-item dismiss with reactive unread count and Clear all [Signal, data_show, sum(), data_text]

Notifications

unread

Deployment complete

v2.4.1 deployed to production

New comment

Priya commented on PR #417

Build failed

CI pipeline timed out on staging

API Reference

Props

Prop Type Default Description
signal str | Signal auto-generated Signal name for open state
modal bool True Use showModal() for focus trapping and backdrop
side Literal['top','right','bottom','left'] 'right' Edge the sheet slides from
size Literal['sm','md','lg','xl','full'] 'sm' Width constraint for left/right sheets
show_close bool True Show the default close button
Component Description
Sheet Root container managing open state via Datastar signal
SheetTrigger Button that opens the sheet
SheetContent Panel container; supports side and size
SheetHeader Header layout for title and description
SheetTitle Accessible title linked to content
SheetDescription Supplementary description text
SheetFooter Footer area for actions
SheetClose Action that closes the sheet