A side panel component that slides in from the screen edge. Perfect for navigation menus, filter panels, settings drawers, and detail views.
Installation
CLI
Install the component using the StarUI CLI:
Examples
Side
Sheets sliding from all four screen edges
Sizes
Width variants from small to extra large
No Close Button
Custom close with show_close=False
Notifications
Per-item dismiss with reactive unread count and Clear all [Signal, data_show, sum(), data_text]
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 |