@drawerly/react / DrawerOptions

DrawerOptions

Shared options for all drawers.

Extended by

• ReactDrawerOptions

Properties

ariaDescribedBy?

optional ariaDescribedBy: string;

ARIA describedby id for the drawer panel.

---

ariaLabel?

optional ariaLabel: string;

ARIA label for the drawer panel.

---

ariaLabelledBy?

optional ariaLabelledBy: string;

ARIA labelledby id for the drawer panel.

---

closeOnBackdropClick?

optional closeOnBackdropClick: DrawerPredicate<DrawerOptions>;

Whether clicking the backdrop closes the drawer.

Default Value

true

---

closeOnEscapeKey?

optional closeOnEscapeKey: DrawerPredicate<DrawerOptions>;

Whether pressing Escape closes the drawer.

Default Value

true

---

dataAttributes?

optional dataAttributes: Record<`data-${string}`, string | number | boolean | null | undefined>;

Extra data attributes applied to the overlay element.

---

drawerKey

drawerKey: string;

Unique key identifying the drawer instance.

---

placement?

optional placement: DrawerPlacement;

Drawer placement.

Default Value

'right'