@drawerly/react / UseDrawerResult

UseDrawerResult<TDrawerOptions>

Returned by useDrawer.

Type Parameters

TDrawerOptions

TDrawerOptions extends ReactDrawerOptions = ReactDrawerOptions

Properties

bringToTop()

bringToTop: () => void;

Moves the drawer to the top of the stack.

Returns

void

---

close()

close: () => void;

Closes the drawer.

Returns

void

---

instance

instance: TDrawerOptions | undefined;

The drawer instance, or undefined while closed.

---

isOpen

isOpen: boolean;

Whether the drawer is in the stack.

---

isTop

isTop: boolean;

Whether the drawer is the topmost one in the stack.

---

updateOptions()

updateOptions: (patch) => void;

Merges a patch into the drawer's options.

Parameters

patch

DrawerPatch<TDrawerOptions>

Returns

void