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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- elrequiredRef<HTMLElement | null | undefined>
- The sheet root element — used to read its current rendered height.
- handlerequiredRef<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.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Passing options to useSheetSwipe