| animation | true | boolean |
How the drawer comes in. Left out it slides in from its placement; false turns the animation off. |
| backdrop | true | boolean, 'static' |
Apply a backdrop while the drawer is open. 'static' keeps it open on a backdrop click and bounces it instead. |
| backdropVariant6.0.0+ | - | 'translucent', 'scrim' |
Pick the backdrop's look: the dark scrim or the translucent tint of the page. Left out, the component keeps its own default. |
| className | - | string |
A string of all className you want applied to the base component. |
| dark6.0.0+ | - | boolean |
Flip the drawer to the dark color mode, whatever the page around it uses. |
| defaultShow6.0.0+ | - | boolean |
The initial open state of an uncontrolled drawer — read once on mount. |
| fitContent | - | boolean |
Size the drawer to its content instead of the full edge. |
| fullscreen | - | boolean |
Set the drawer to cover the entire user viewport. |
| keyboard | true | boolean |
Closes the drawer when escape key is pressed. |
| onClose | - | (() => void) |
Callback fired once the component has closed. |
| onClosePrevented | - | (() => void) |
Callback fired when a static backdrop or a disabled keyboard refuses a close request. |
| onShow | - | (() => void) |
Callback fired when the component requests to be shown. |
| onShowChange6.0.0+ | - | ((show: boolean) => void) |
Callback fired when the drawer requests an open-state change — a dismiss gesture (Escape, backdrop click) or, in uncontrolled mode, any internal toggle. In controlled mode update show yourself, or the drawer stays as it is. |
| placement | - | 'start', 'end', 'top', 'bottom' |
The edge the drawer slides in from. A fullscreen drawer covers the viewport and needs none. |
| responsive | true | boolean, 'sm', 'md', 'lg', 'xl', '2xl' |
Hide the drawer outside the viewport from a specified breakpoint and down. |
| scroll | - | boolean |
Allow the page behind the drawer to scroll. |
| sheet | - | boolean |
Drop the inset and the rounded corners, so the drawer sits flush against the edge. |
| show6.0.0+ | - | boolean |
Control the open state. When set, the drawer renders what show says and dismiss gestures only call onShowChange — nothing closes until the parent flips the prop. |
| translucent | - | boolean |
Blur and saturate whatever is behind the drawer. |
| visibleDeprecated 6.0.0 | - | boolean |
Toggle the visibility of the drawer component. Use defaultShow / show / onShowChange instead — visible is ignored when either of them is set. |