drawer API
overlays/drawer.tsx
Drawer
Props
| Prop | Type | Default | Description |
|---|---|---|---|
children* | React.ReactNode | — | |
open* | boolean | — | |
side | DrawerSide | undefined | right | Edge to slide in from. |
size | DrawerSize | undefined | md | Panel size preset. |
description | any | — | Secondary line under the title, wired to `aria-describedby`. |
showCloseButton | boolean | undefined | true | Show an ✕ button in the header. |
hotkeys | {} | undefined | [] | Additional hotkeys active while the drawer is open. |
Show native HTML props
Native HTML Props
| Prop | Type | Default | Description |
|---|---|---|---|
onOpenChange* | (open: boolean) => void | — | Called with `false` when the drawer requests to close (Escape, backdrop, ✕ button). |
title | any | — | Header heading; labels the dialog for assistive tech. |
aria-label | string | undefined | — | Accessible name when no `title` is rendered. |
className | string | undefined | — |