ISheetSwipeReturn
interface
Composable Return
Public surface returned by useSheetSwipe(). Exposes reactive state (currentSnap, dragOffset, isDragging, currentSnapHeight) and imperative controls (snapTo, dismiss) to drive the bottom-sheet from outside the composable.
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.
- currentSnaprequisRef<TSheetSnapId>
- The currently-active snap id.
- dragOffsetrequisRef<number>
- Live drag delta during a gesture (px from snap baseline).
- isDraggingrequisRef<boolean>
- True while a pointer is held on the handle.
- snapTorequis(id: TSheetSnapId) => void
- Imperative snap — programmatically move the sheet to a named snap point.
- dismissrequis() => void
- Convenience alias for snapTo("closed").
- currentSnapHeightrequisRef<number>
- Resolved height (in px) of the active snap point. Useful for layout maths and test assertions.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Programmatic sheet control via useSheetSwipe