ISheetSwipeOptions
interface
Composable Options
Options bag passed to useSheetSwipe() — the bottom-sheet drag gesture composable. Wires reactive refs for the sheet element, the drag handle, snap-points, and behavioural flags.
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.
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.
- elrequisRef<HTMLElement | null | undefined>
- The sheet root element — used to read its current rendered height.
- handlerequisRef<HTMLElement | null | undefined>
- The drag-handle element — pointer events bind to this only, keeping the sheet body interactive.
- snapPointsRef<ReadonlyArray<TSheetSnapPoint>>
- Ordered list of snap points (any order; the composable sorts them). Defaults to closed / peek / half / full.
- defaultSnapRef<TSheetSnapId>
- Initial snap id; defaults to "half".
- disabledRef<boolean | undefined>
- When true, ignore pointer events entirely.
- persistentRef<boolean | undefined>
- When true, dragging past closed snaps back instead of dismissing.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Passing options to useSheetSwipe