Vue Drawer Component API

How the drawer comes in. Left out it slides in from its placement; false turns the animation off.

Apply a backdrop while the drawer is open. 'static' keeps it open on a backdrop click and bounces it instead.

Pick the backdrop's look: the dark scrim or the translucent tint of the page. Left out, the component keeps its own default.

Flip the drawer to the dark color mode, whatever the page around it uses.

Size the drawer to its content instead of the full edge.

Set the drawer to cover the entire user viewport.

Closes the drawer when escape key is pressed.

The edge the drawer slides in from. A fullscreen drawer covers the viewport and needs none.

Hide the drawer outside the viewport from a specified breakpoint and down.

Allow the page behind the drawer to scroll.

Drop the inset and the rounded corners, so the drawer sits flush against the edge.

Control the open state. When set, the drawer renders what show says and dismiss gestures only emit update:show — nothing closes until the parent flips the prop.

Blur and saturate whatever is behind the drawer.

Toggle the visibility of the drawer component.

Use show / v-model:show instead — visible is ignored when show is set.

Callback fired once the component has closed.

Callback fired when a static backdrop or a disabled keyboard refuses a close request.

Callback fired when the component requests to be shown.

Callback fired when the drawer requests an open-state change — a dismiss gesture (Escape, backdrop click) or any internal toggle. In controlled mode update show yourself, or the drawer stays as it is.