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

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

side
TDirectionBoth
Edge the sheet is anchored to. Only bottom activates the swipe-to-expand gesture today; other values are reserved for future side-sheet patterns.
swipeable
boolean
Enable the mobile-style swipe-to-expand / swipe-to-dismiss gesture. Requires side === "bottom".
snapPoints
ReadonlyArray<TSheetSnapPoint>
Discrete snap-points the sheet can settle on between drags. Each point is a px number or a CSS length string.
defaultSnap
TSheetSnapId
Initial snap id when the sheet mounts. Defaults to "half".
open
boolean
v-model:open binding — false maps to the closed snap, truthy keeps the last non-closed snap.
disabled
boolean
Disables the swipe gesture entirely. The sheet stays at defaultSnap and pointer events on the handle are no-ops.
persistent
boolean
Persistent sheets cannot be swiped past closed — a fast downward flick snaps back instead of dismissing.
handleLabel
string

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Bottom sheet with swipe gesture

vue