@drawerly/react / DrawerlyContainerProps

DrawerlyContainerProps<TDrawerOptions>

Props accepted by DrawerlyContainer.

Type Parameters

TDrawerOptions

TDrawerOptions extends ReactDrawerOptions = ReactDrawerOptions

Properties

children()?

optional children: (props) => ReactNode;

Renders the panel content of drawers that do not specify a component.

Parameters

props

close

() => void

drawer

TDrawerOptions

Returns

ReactNode

---

drawerly

drawerly: Drawerly<TDrawerOptions>;

Drawerly instance whose stack this container renders.

---

lockScroll?

optional lockScroll: boolean;

Locks body scroll while a modal drawer is on screen.

Default Value

true

---

modal?

optional modal: boolean;

Renders drawers as modal dialogs: backdrop, body scroll locking and aria-modal.

Default Value

true

---

onAllClosed()?

optional onAllClosed: () => void;

Called when the last drawer has finished closing.

Returns

void

---

onDrawerClosed()?

optional onDrawerClosed: (payload) => void;

Called when a drawer finishes closing.

Parameters

payload

key

string

Returns

void

---

onDrawerOpened()?

optional onDrawerOpened: (payload) => void;

Called when a drawer finishes opening.

Parameters

payload

key

string

Returns

void

---

portalTo?

optional portalTo: string;

Portal target selector for the drawer stack.

Default Value

'body'