API reference
Generated from each primitive's $props() declaration.
Drawer.Root
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| shouldScaleBackground | boolean | true | |
| open bind: | boolean | false | |
| activeSnapPoint bind: | — | null | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Close
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Content
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| portalProps | — | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Description
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Footer
Slide-out panel from screen edge.
| 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. |
Drawer.Header
Slide-out panel from screen edge.
| 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. |
Drawer.NestedRoot
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| shouldScaleBackground | boolean | true | |
| open bind: | boolean | false | |
| activeSnapPoint bind: | — | null | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Overlay
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Title
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Drawer.Trigger
Slide-out panel from screen edge.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |