element
element: HTMLElement
Optionalhandle
handle?: HTMLElement
scrollContainer?: HTMLElement
Optionalbackdrop
backdrop?: HTMLElement
Optionalscrim
scrim?: HTMLElement
OptionalscreenComponent
screenComponent?: HTMLElement
Optionalallowed
allowed?: string[]
Optionalinitial
initial?: string
Optionalduration
duration?: number
Optionaleasing
easing?: (t: number) => number
OptionalrespectReducedMotion
respectReducedMotion?: boolean
OptionalflickVelocity
flickVelocity?: number
OptionaldragThreshold
dragThreshold?: number
OptionaldragFrom
dragFrom?: DragFrom
OptionaldragFromContent
dragFromContent?: boolean
OptionalfitContentToSnap
fitContentToSnap?: boolean
OptionalrubberBand
rubberBand?: boolean
OptionalbackdropRange
backdropRange?: [number, number]
OptionalscreenRange
screenRange?: [number, number]
OptionalscrimMode
scrimMode?: "full" | "above-sheet" | "off"
OptionalscrimColor
scrimColor?: string
OptionalscrimBlur
scrimBlur?: string
OptionalscrimInteractive
scrimInteractive?: boolean
OptionalscrimTapToClose
scrimTapToClose?: boolean
Optionalanimation
animation?:
| "spring"
| "tween"
| "ios-spring"
| "material-bounce"
| "linear"
| "snappy"
OptionalsettleAnimation
settleAnimation?: "waapi"
Optionalspring
spring?: { stiffness?: number; damping?: number; mass?: number }
OptionalfocusTrap
focusTrap?: boolean
OptionalinitialFocus
initialFocus?: string | HTMLElement | false
OptionalcloseOnEscape
closeOnEscape?: boolean
OptionallockBodyScroll
lockBodyScroll?: boolean
OptionalcloseOnBack
closeOnBack?: boolean
OptionalroutedTo
routedTo?: string
OptionalinertSiblings
inertSiblings?: boolean
Optionalpersistent
persistent?: boolean
OptionaldisableClose
disableClose?: boolean
OptionaldisableDrag
disableDrag?: boolean
OptionalcloseOnRouteChange
closeOnRouteChange?: boolean
Optionalradius
radius?: string | number
OptionalmaxHeight
maxHeight?: string | number
OptionalreturnFocusTo
returnFocusTo?: HTMLElement | string | (() => HTMLElement | null)
OptionalpersistKey
persistKey?: string
OptionalautoCollapseAfter
autoCollapseAfter?: number
OptionallinkedSheets
linkedSheets?: BottomSheetEngineLike[]
OptionalviewTransitions
viewTransitions?: boolean
OptionalstackEffect
stackEffect?: boolean