API reference
Generated from each primitive's $props() declaration.
Sheet.Close
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Content
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| side | "top" | "bottom" | "left" | "right" | "right" | |
| portalProps | — | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Description
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Footer
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Header
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Overlay
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Title
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Sheet.Trigger
Slide-out panel overlay.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |