Drawer
v0.4.8StableA `Card` docked to one edge of the viewport as a slide-in panel, built on [Radix `Dialog`](https://www.radix-ui.com/primitives/docs/components/dialog) for focus trapping, Escape-to-close, and outside-click-to-close. It has no opinion on what goes inside the panel — an optional `title` renders a header with a close button, otherwise just the `children` are shown.
A Card docked to one edge of the viewport as a slide-in panel, built on
Radix Dialog
for focus trapping, Escape-to-close, and outside-click-to-close. It has no
opinion on what goes inside the panel — an optional title renders a header
with a close button, otherwise just the children are shown.
placement controls which edge it docks to; backdrop controls whether it
blocks the rest of the page or floats alongside content the user can keep
interacting with, e.g. an always-visible properties panel. For a centered
dialog that always blocks the page, use @behivetech/atoms.modal instead.
Usage
Examples
Open all 4 →Properties
Drawer props
| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | Panel content |
onClose* | () => void | — | Called when the drawer is dismissed (backdrop click, Escape, or the close button) |
placement* | "top" | "right" | "bottom" | "left" | — | Which edge the panel slides in from |
backdrop | boolean | true | Whether a dimmed backdrop covers the rest of the page, blocks interaction with it, and closes the drawer when clicked — a real modal. Defaults to true. Set false for a non-blocking panel that floats alongside content the user can keep interacting with, e.g. an always-visible properties panel that updates as a different item is selected behind it. |
className | string | — | Additional class names to merge with the component root element |
headingLevel | 1 | 2 | 3 | 4 | 5 | 6 | — | Which heading tag wraps `title` — same values as `Card`'s `headingLevel` prop |
icon | ReactNode | — | Optional icon rendered before the title in the header; ignored if `title` is omitted |
padding | "sm" | "md" | "none" | "lg" | — | Internal padding of the panel body — same values as `Card`'s `padding` prop |
title | string | — | Optional header title; omit to render no header and no close button |
Also accepts the native attributes of its root element (className, aria-*, event handlers, …).