Skip to content

@agala-labs/ui

Drawer

Presents a focused task from an edge of the viewport.

Examples

Default
<AgalaDrawer :open="open" title="Inventory filters" @close="open = false">…</AgalaDrawer>

Import

import { AgalaDrawer } from '@agala-labs/ui'

API

PropTypeDefaultDescription
openbooleanRequired controlled visibility.
titlestringVisible and accessible drawer heading.
placement'left' | 'right' | 'top' | 'bottom''right'Viewport edge and enter/leave direction.
sizestringCSS size value, clamped to the viewport.
dismissiblebooleantrueAllows backdrop dismissal and shows the close button.
escapeClosesbooleantrueAllows Escape dismissal independently.
classstringConsumer override class.

Events

  • close

Slots

  • header
  • default
  • footer — receives { close }

Accessibility

Traps focus while present, keeps background scrolling locked through the leave transition, then restores the opener. Entry and exit follow the configured edge and reduced motion removes meaningful travel.

Released under the MIT License.