Overlay
Offcanvas
A panel that slides in from a screen edge. Its keyboard and screen-reader handling matches Modal.
ReactVueWeb Components
View in Storybook Playground
Examples
<Offcanvas open={open} onClose={close} placement="end" title="Menu">…</Offcanvas>Props
| Name | Type | Default | Description |
|---|---|---|---|
open required | boolean | — | Whether the panel is open. |
onClose required | () => void | — | Called when the panel requests to close. |
placement | OffcanvasPlacement | start | Edge to slide in from. @default 'start' |
title | ReactNode | — | Panel title (accessible name). |
children required | ReactNode | — | Body content. |
className | string | — |
Accessibility
- Body/background contrast is ≥ 7:1 (AAA) in both light and dark.
- Every interaction works with the keyboard alone.
- The focus ring is always visible.
- Respects prefers-reduced-motion and stops excessive motion.
Every component is designed to meet WCAG 2.1 AAA.