ISheetProps
interface
Component Props
Full props contract for <OrigamSheet> — a bottom/side sheet with optional swipe-to-expand gesture, discrete snap-points, and the full design surface (color, border, spacing, elevation, position).
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.
- sideTDirectionBoth
- Edge the sheet is anchored to. Only bottom activates the swipe-to-expand gesture today; other values are reserved for future side-sheet patterns.
- swipeableboolean
- Enable the mobile-style swipe-to-expand / swipe-to-dismiss gesture. Requires side === "bottom".
- snapPointsReadonlyArray<TSheetSnapPoint>
- Discrete snap-points the sheet can settle on between drags. Each point is a px number or a CSS length string.
- defaultSnapTSheetSnapId
- Initial snap id when the sheet mounts. Defaults to "half".
- openboolean
- v-model:open binding — false maps to the closed snap, truthy keeps the last non-closed snap.
- disabledboolean
- Disables the swipe gesture entirely. The sheet stays at defaultSnap and pointer events on the handle are no-ops.
- persistentboolean
- Persistent sheets cannot be swiped past closed — a fast downward flick snaps back instead of dismissing.
- handleLabelstring
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Bottom sheet with swipe gesture