| animation6.0.0+ | true | boolean |
Remove animation to create an offcanvas that simply appears rather than slides into view. |
| backdrop | true | boolean, 'static' |
Apply a backdrop on body while offcanvas is open. 'static' keeps it open on a backdrop click and bounces it instead. |
| className | - | string |
A string of all className you want applied to the base component. |
| dark | - | boolean |
Sets a darker color scheme. |
| defaultShow6.0.0+ | - | boolean |
The initial open state of an uncontrolled offcanvas — read once on mount. |
| keyboard | true | boolean |
Closes the offcanvas when escape key is pressed. |
| onHide | - | (() => void) |
Callback fired once the component has been hidden. |
| onShow | - | (() => void) |
Callback fired when the component requests to be shown. |
| onShowChange6.0.0+ | - | ((show: boolean) => void) |
Callback fired when the offcanvas 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 offcanvas stays as it is. |
| placement | - | 'start', 'end', 'top', 'bottom' |
Components placement, there’s no default placement. |
| responsive4.6.0+ | true | boolean, 'sm', 'md', 'lg', 'xl', '2xl' |
Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down. |
| scroll | - | boolean |
Allow body scrolling while offcanvas is open |
| show6.0.0+ | - | boolean |
Control the open state. When set, the offcanvas renders what show says and dismiss gestures only call onShowChange — nothing closes until the parent flips the prop. |
| visibleDeprecated 6.0.0 | - | boolean |
Toggle the visibility of offcanvas component. Use defaultShow / show / onShowChange instead — visible is ignored when either of them is set. |