Class BottomSheetEngine

Hierarchy (View Summary)

BottomSheetCore
- BottomSheetEngine

Constructors

constructor

new BottomSheetEngine(opts: EngineOptions): BottomSheetEngine
Parameters
- opts: EngineOptions
Returns BottomSheetEngine
Overrides BottomSheetCore.constructor
- Defined in core/BottomSheetEngine.ts:6

Accessors

state

get state(): EngineState
Returns EngineState
Inherited from BottomSheetCore.state
- Defined in core/BottomSheetCore.ts:443

Methods

on

on<K extends keyof SheetEventMap>(event: K, fn: Listener<K>): () => void
Type Parameters
- K extends keyof SheetEventMap
Parameters
- event: K
- fn: Listener<K>
Returns () => void
Inherited from BottomSheetCore.on
- Defined in core/BottomSheetCore.ts:453

use

use(plugin: Plugin): this
Parameters
- plugin: Plugin
Returns this
Inherited from BottomSheetCore.use
- Defined in core/BottomSheetCore.ts:457

setLinkedSheets

setLinkedSheets(sheets: BottomSheetCore[]): void
Parameters
- sheets: BottomSheetCore[]
Returns void
Inherited from BottomSheetCore.setLinkedSheets
- Defined in core/BottomSheetCore.ts:495

getAllowedIds

getAllowedIds(): string[]
Returns string[]
Inherited from BottomSheetCore.getAllowedIds
- Defined in core/BottomSheetCore.ts:500

getResolvedSnaps

getResolvedSnaps(): readonly { id: string; size: number }[]
Returns readonly { id: string; size: number }[]
Inherited from BottomSheetCore.getResolvedSnaps
- Defined in core/BottomSheetCore.ts:504

snapTo

snapTo(
    id: string,
    velocityOrOpts?: number | { velocity?: number; signal?: AbortSignal },
    _skipBeforeSnap?: boolean,
): Promise<void>
Parameters
- id: string
- velocityOrOpts: number | { velocity?: number; signal?: AbortSignal } = 0
- _skipBeforeSnap: boolean = false
Returns Promise<void>
Inherited from BottomSheetCore.snapTo
- Defined in core/BottomSheetCore.ts:508

dragTo

dragTo(
targetSize: number,
velocityOrOpts?: number | { velocity?: number; signal?: AbortSignal },
): Promise<void>
Parameters
- targetSize: number
- velocityOrOpts: number | { velocity?: number; signal?: AbortSignal } = 0
Returns Promise<void>
Inherited from BottomSheetCore.dragTo
- Defined in core/BottomSheetCore.ts:625

open

open(id?: string): Promise<void>
Parameters
- Optionalid: string
Returns Promise<void>
Inherited from BottomSheetCore.open
- Defined in core/BottomSheetCore.ts:651

close

close(reason?: CloseReason): Promise<void>
Parameters
- reason: CloseReason = "programmatic"
Returns Promise<void>
Inherited from BottomSheetCore.close
- Defined in core/BottomSheetCore.ts:662

canDismiss

canDismiss(): boolean
Returns boolean
Inherited from BottomSheetCore.canDismiss
- Defined in core/BottomSheetCore.ts:675

setPersistent

setPersistent(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BottomSheetCore.setPersistent
- Defined in core/BottomSheetCore.ts:679

setDisableClose

setDisableClose(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BottomSheetCore.setDisableClose
- Defined in core/BottomSheetCore.ts:684

setDisableDrag

setDisableDrag(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BottomSheetCore.setDisableDrag
- Defined in core/BottomSheetCore.ts:689

setDragFromContent

setDragFromContent(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BottomSheetCore.setDragFromContent
- Defined in core/BottomSheetCore.ts:694

setDragFrom

setDragFrom(mode: DragFrom): void
Parameters
- mode: DragFrom
Returns void
Inherited from BottomSheetCore.setDragFrom
- Defined in core/BottomSheetCore.ts:699

getDragFrom

getDragFrom(): DragFrom
Returns DragFrom
Inherited from BottomSheetCore.getDragFrom
- Defined in core/BottomSheetCore.ts:707

setMode

setMode(mode: SheetMode): void
Parameters
- mode: SheetMode
Returns void
Inherited from BottomSheetCore.setMode
- Defined in core/BottomSheetCore.ts:711

getMode

getMode(): TransformAxis
Returns TransformAxis
Inherited from BottomSheetCore.getMode
- Defined in core/BottomSheetCore.ts:746

isTop

isTop(): boolean
Returns boolean
Inherited from BottomSheetCore.isTop
- Defined in core/BottomSheetCore.ts:750

depth

depth(): number
Returns number
Inherited from BottomSheetCore.depth
- Defined in core/BottomSheetCore.ts:754

expand

expand(): Promise<void>
Returns Promise<void>
Inherited from BottomSheetCore.expand
- Defined in core/BottomSheetCore.ts:758

collapse

collapse(): Promise<void>
Returns Promise<void>
Inherited from BottomSheetCore.collapse
- Defined in core/BottomSheetCore.ts:766

setRadius

setRadius(r: string | number): void
Parameters
- r: string | number
Returns void
Inherited from BottomSheetCore.setRadius
- Defined in core/BottomSheetCore.ts:775

setMaxHeight

setMaxHeight(h: string | number): void
Parameters
- h: string | number
Returns void
Inherited from BottomSheetCore.setMaxHeight
- Defined in core/BottomSheetCore.ts:780

setAllowed

setAllowed(ids: string[], snap?: string): void
Parameters
- ids: string[]
- Optionalsnap: string
Returns void
Inherited from BottomSheetCore.setAllowed
- Defined in core/BottomSheetCore.ts:785

setBackdropRange

setBackdropRange(range: [number, number]): void
Parameters
- range: [number, number]
Returns void
Inherited from BottomSheetCore.setBackdropRange
- Defined in core/BottomSheetCore.ts:797

setScreenRange

setScreenRange(range: [number, number]): void
Parameters
- range: [number, number]
Returns void
Inherited from BottomSheetCore.setScreenRange
- Defined in core/BottomSheetCore.ts:801

setScrimColor

setScrimColor(color: string | null | undefined): void
Parameters
- color: string | null | undefined
Returns void
Inherited from BottomSheetCore.setScrimColor
- Defined in core/BottomSheetCore.ts:805

setScrimBlur

setScrimBlur(blur: string | null | undefined): void
Parameters
- blur: string | null | undefined
Returns void
Inherited from BottomSheetCore.setScrimBlur
- Defined in core/BottomSheetCore.ts:809

setScrimInteractive

setScrimInteractive(interactive: boolean): void
Parameters
- interactive: boolean
Returns void
Inherited from BottomSheetCore.setScrimInteractive
- Defined in core/BottomSheetCore.ts:813

setScrim

setScrim(opts: ScrimUpdate): void
Parameters
- opts: ScrimUpdate
Returns void
Inherited from BottomSheetCore.setScrim
- Defined in core/BottomSheetCore.ts:817

setScrimMode

setScrimMode(mode: "full" | "above-sheet" | "off"): void
Parameters
- mode: "full" | "above-sheet" | "off"
Returns void
Inherited from BottomSheetCore.setScrimMode
- Defined in core/BottomSheetCore.ts:821

setScrimTapToClose

setScrimTapToClose(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Inherited from BottomSheetCore.setScrimTapToClose
- Defined in core/BottomSheetCore.ts:825

setScrimEnabled

setScrimEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Inherited from BottomSheetCore.setScrimEnabled
- Defined in core/BottomSheetCore.ts:829

setScrimOverlay

setScrimOverlay(opts: ScrimOverlayOptions): () => void
Parameters
- opts: ScrimOverlayOptions
Returns () => void
Inherited from BottomSheetCore.setScrimOverlay
- Defined in core/BottomSheetCore.ts:833

addAnchor

addAnchor(opts: AnchorOptions): () => void
Parameters
- opts: AnchorOptions
Returns () => void
Inherited from BottomSheetCore.addAnchor
- Defined in core/BottomSheetCore.ts:837

setScrimStages

setScrimStages(opts: ScrimStagesOptions | null): () => void
Parameters
- opts: ScrimStagesOptions | null
Returns () => void
Inherited from BottomSheetCore.setScrimStages
- Defined in core/BottomSheetCore.ts:874

getScrimState

getScrimState(): { mode: "full" | "above-sheet" | "off"; enabled: boolean }
Returns { mode: "full" | "above-sheet" | "off"; enabled: boolean }
Inherited from BottomSheetCore.getScrimState
- Defined in core/BottomSheetCore.ts:909

setSnapPoints

setSnapPoints(points: SnapPointDef<string>[], allowed?: string[]): void
Parameters
- points: SnapPointDef<string>[]
- Optionalallowed: string[]
Returns void
Inherited from BottomSheetCore.setSnapPoints
- Defined in core/BottomSheetCore.ts:916

recompute

recompute(): void
Returns void
Inherited from BottomSheetCore.recompute
- Defined in core/BottomSheetCore.ts:950

destroy

destroy(): void
Returns void
Inherited from BottomSheetCore.destroy
- Defined in core/BottomSheetCore.ts:976