Skip to main content

Interface: DrawerProps

Defined in: composites/Drawer/Drawer.tsx:195

Props for the Drawer composite.

Extends​

  • Omit<RACModalOverlayProps, "style" | "className" | "children">

Properties​

aria-label​

aria-label: string

Defined in: composites/Drawer/Drawer.tsx:223

Accessible name for the panel. Required: the drawer renders a dialog, and a dialog without a name is announced as an unlabelled region (ADR-001 — flow-critical copy is caller-supplied, never defaulted in English).

children?​

optional children?: ReactNode

Defined in: composites/Drawer/Drawer.tsx:225

The panel's content.

evaluation?​

optional evaluation?: "primary" | "secondary" | "accent" | "muted" | "negative"

Defined in: composites/Drawer/Drawer.tsx:217

Semantic emphasis for the surface colours.

Default​

'primary'

placement?​

optional placement?: DrawerPlacement

Defined in: composites/Drawer/Drawer.tsx:204

Which edge the panel is anchored to. start/end are logical — a start drawer anchors right in an RTL document.

Default​

'start'

width?​

optional width?: "sm" | "md" | "lg"

Defined in: composites/Drawer/Drawer.tsx:212

Panel measure on its main axis, from the named scale shared with AppShell's side regions — so a drawer standing in for a sidebar is the same width the sidebar would have been. Ignored for top/bottom, which are sized by their content.

Default​

'sm'