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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

disableResizeWatcher
boolean
Disable the internal ResizeObserver that auto-closes a temporary drawer on viewport shrink.
disableRouteWatcher
boolean
Disable automatic close on route change (useful when the drawer should persist across navigation).
expandOnHover
boolean
Expand a rail drawer to full width when the pointer enters it.
floating
boolean
Remove the border/shadow that separates the drawer from the content area for a seamless look.
modelValue
boolean
v-model open/closed state. Ignored for permanent drawers.
permanent
boolean | null
Always visible; ignores modelValue and overlay behaviour.
rail
boolean | null
Collapse the drawer to icon-only width.
railWidth
number | string
Override the icon-only collapsed width when rail is true.
temporary
boolean
Show a scrim behind the drawer and close on outside click or Escape.
touchless
boolean
Disable swipe-to-open/close gesture handling.
width
number | string
Override the default expanded drawer width.
sticky
boolean
Keep the drawer visible while the user scrolls (position: sticky semantics).
push
boolean | null
When true, adjacent layout items offset themselves to make room. null (default) derives from permanent.
clipped
boolean | null
When true, the drawer slots below top-anchored layout items (e.g. AppBar). null derives from HTML declaration order.
attach
boolean | string | Element | null

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Rail drawer that expands on hover

html