@drawerly/react / ReactDrawerOptions

ReactDrawerOptions

Drawer options for the React adapter.

Extends

• DrawerOptions

Properties

ariaDescribedBy?

optional ariaDescribedBy: string;

ARIA describedby id for the drawer panel.

Inherited from

DrawerOptions.ariaDescribedBy

---

ariaLabel?

optional ariaLabel: string;

ARIA label for the drawer panel.

Inherited from

DrawerOptions.ariaLabel

---

ariaLabelledBy?

optional ariaLabelledBy: string;

ARIA labelledby id for the drawer panel.

Inherited from

DrawerOptions.ariaLabelledBy

---

closeOnBackdropClick?

optional closeOnBackdropClick: DrawerPredicate<ReactDrawerOptions>;

Whether clicking the backdrop closes the drawer.

Default Value

true

Inherited from

DrawerOptions.closeOnBackdropClick

---

closeOnEscapeKey?

optional closeOnEscapeKey: DrawerPredicate<ReactDrawerOptions>;

Whether pressing Escape closes the drawer.

Default Value

true

Inherited from

DrawerOptions.closeOnEscapeKey

---

component?

optional component: ComponentType<any>;

Component rendered inside the drawer panel.

---

componentProps?

optional componentProps: Record<string, unknown>;

Props passed to the rendered component.

---

dataAttributes?

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

Extra data attributes applied to the overlay element.

Inherited from

DrawerOptions.dataAttributes

---

drawerKey

drawerKey: string;

Unique key identifying the drawer instance.

Inherited from

DrawerOptions.drawerKey

---

placement?

optional placement: DrawerPlacement;

Drawer placement.

Default Value

'right'

Inherited from

DrawerOptions.placement