API Reference

Interfaces

Interface	Description
DrawerContentProps	Prop injected into every component rendered inside a drawer panel.
Drawerly	Drawerly instance created by createDrawerly.
DrawerlyOptions	Configuration options for createDrawerly.
DrawerManager	Public API for managing a stack of drawers.
DrawerManagerConfig	Configuration accepted by createDrawerManager.
DrawerOptions	Shared options for all drawers.
DrawerState	Drawer manager state.
UseDrawerResult	Returned by useDrawer.
VueDrawerOptions	Drawer options for the Vue adapter.

Type Aliases

Type Alias	Description
DrawerDefaultOptions	Default options applied to new drawers.
DrawerInstance	Concrete drawer instance (full options including drawerKey).
DrawerKey	Key used to identify a drawer instance.
DrawerListener	Listener called whenever the drawer state changes.
DrawerOptionsWithoutKey	Drawer options without the drawerKey field.
DrawerPatch	Partial set of options merged into a drawer.
DrawerPlacement	Placement of a drawer relative to the viewport.
DrawerPredicate	Predicate used for drawer behaviors.
Unsubscribe	Function that unsubscribes a state listener.

Variables

Variable	Description
BASE_DRAWER_DEFAULTS	Built-in defaults applied to every drawer manager.
DrawerlyContainer	Renders and animates the active drawer stack.
drawerlyInjectionKey	Injection key for the Drawerly instance.

Functions

Function	Description
createDrawerly	Creates a Drawerly instance to be installed with app.use().
createDrawerManager	Creates a new drawer manager backed by an in-memory stack.
resolveDrawerPredicate	Resolves a DrawerPredicate against a drawer instance.
useDrawer	Binds to the drawer with the given key.
useDrawerly	Returns the installed Drawerly instance.