@surdeddd/bottom-sheet
    Preparing search index...

    Type Alias UseBottomSheetVueReturn<TId>

    type UseBottomSheetVueReturn<TId extends string = string> = {
        sheetRef: Ref<HTMLElement | null>;
        handleRef: Ref<HTMLElement | null>;
        contentRef: Ref<HTMLElement | null>;
        backdropRef: Ref<HTMLElement | null>;
        screenRef: Ref<HTMLElement | null>;
        state: EngineState & { activeId: TId };
        snapTo: (id: TId) => Promise<void>;
        open: (id?: TId) => Promise<void>;
        close: (reason?: CloseReason) => Promise<void>;
        setAllowed: (ids: TId[], snap?: TId) => void;
        setSnapPoints: (
            points: EngineOptions["snapPoints"],
            allowed?: string[],
        ) => void;
        setScrim: (opts: ScrimUpdate) => void;
        setScrimOverlay: (opts: ScrimOverlayOptions) => () => void;
        addAnchor: (opts: AnchorOptions) => () => void;
        setScrimStages: (opts: ScrimStagesOptions | null) => () => void;
        recompute: () => void;
        setScrimColor: (color: string | undefined | null) => void;
        setBackdropRange: (range: [number, number]) => void;
        setRadius: (r: string | number) => void;
        setMaxHeight: (h: string | number) => void;
        expand: () => Promise<void>;
        collapse: () => Promise<void>;
        isTop: () => boolean;
        depth: () => number;
        canDismiss: () => boolean;
        on: <K extends keyof SheetEventMap>(
            event: K,
            fn: (payload: SheetEventMap[K]) => void,
        ) => () => void;
        getEngine: () => BottomSheetEngine | null;
    }

    Type Parameters

    • TId extends string = string
    Index
    sheetRef: Ref<HTMLElement | null>
    handleRef: Ref<HTMLElement | null>
    contentRef: Ref<HTMLElement | null>
    backdropRef: Ref<HTMLElement | null>
    screenRef: Ref<HTMLElement | null>
    state: EngineState & { activeId: TId }
    snapTo: (id: TId) => Promise<void>
    open: (id?: TId) => Promise<void>
    close: (reason?: CloseReason) => Promise<void>
    setAllowed: (ids: TId[], snap?: TId) => void
    setSnapPoints: (points: EngineOptions["snapPoints"], allowed?: string[]) => void
    setScrim: (opts: ScrimUpdate) => void
    setScrimOverlay: (opts: ScrimOverlayOptions) => () => void
    addAnchor: (opts: AnchorOptions) => () => void
    setScrimStages: (opts: ScrimStagesOptions | null) => () => void
    recompute: () => void
    setScrimColor: (color: string | undefined | null) => void
    setBackdropRange: (range: [number, number]) => void
    setRadius: (r: string | number) => void
    setMaxHeight: (h: string | number) => void
    expand: () => Promise<void>
    collapse: () => Promise<void>
    isTop: () => boolean
    depth: () => number
    canDismiss: () => boolean
    on: <K extends keyof SheetEventMap>(
        event: K,
        fn: (payload: SheetEventMap[K]) => void,
    ) => () => void
    getEngine: () => BottomSheetEngine | null