IDrawerProps
interface
Layout
Props for OrigamDrawer — the side navigation panel. Covers permanent, temporary, rail and expand-on-hover modes, layout reservation (push), viewport positioning (clipped), resize/route watchers and all visual surface props.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- disableResizeWatcherboolean
- Disable the internal ResizeObserver that auto-closes a temporary drawer on viewport shrink.
- disableRouteWatcherboolean
- Disable automatic close on route change (useful when the drawer should persist across navigation).
- expandOnHoverboolean
- Expand a rail drawer to full width when the pointer enters it.
- floatingboolean
- Remove the border/shadow that separates the drawer from the content area for a seamless look.
- modelValueboolean
- v-model open/closed state. Ignored for permanent drawers.
- permanentboolean | null
- Always visible; ignores modelValue and overlay behaviour.
- railboolean | null
- Collapse the drawer to icon-only width.
- railWidthnumber | string
- Override the icon-only collapsed width when rail is true.
- temporaryboolean
- Show a scrim behind the drawer and close on outside click or Escape.
- touchlessboolean
- Disable swipe-to-open/close gesture handling.
- widthnumber | string
- Override the default expanded drawer width.
- stickyboolean
- Keep the drawer visible while the user scrolls (position: sticky semantics).
- pushboolean | null
- When true, adjacent layout items offset themselves to make room. null (default) derives from permanent.
- clippedboolean | null
- When true, the drawer slots below top-anchored layout items (e.g. AppBar). null derives from HTML declaration order.
- attachboolean | string | Element | null
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Rail drawer that expands on hover