API Reference
Every prop across the three components, and the signature of every trigger hook, in one place. See Concepts for how they fit together, or the individual trigger pages for full examples.
Props
| Prop | Type | Description | Default |
|---|
| id | string | Unique key for persistence tracking | — |
| open | boolean | Controls visibility | false |
| onOpenChange | (open: boolean) => void | Callback when open state changes | — |
| animation | "fade" | "zoom" | "bounce" | Open/close animation | "zoom" |
| lockScroll | boolean | Lock body scroll while open | false |
| closeOnOverlay | boolean | Close on overlay click | true |
Props
| Prop | Type | Description | Default |
|---|
| id | string | Unique key for persistence tracking | — |
| open | boolean | Controls visibility | false |
| onOpenChange | (open: boolean) => void | Callback when open state changes | — |
| position | "left" | "right" | Which edge to slide in from | "left" |
| animation | "fade" | "slide" | "bounce" | Animation style | "slide" |
Props
| Prop | Type | Description | Default |
|---|
| id | string | Unique key for persistence tracking | — |
| open | boolean | Controls visibility | false |
| onOpenChange | (open: boolean) => void | Callback when open state changes | — |
| position | "top" | "bottom" | "left" | "right" | Banner placement | "bottom" |
| animation | "fade" | "slide" | "bounce" | Animation style | "slide" |
Trigger hooks