IDrawerProps
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.
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.
- 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
É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