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

    Type Alias BottomSheetProps<TId>

    type BottomSheetProps<TId extends string = string> = {
        snapPoints: SnapPointDef<TId>[] | ReadonlyArray<SnapPointDef<TId>>;
        allowed?: TId[] | ReadonlyArray<TId>;
        initial?: TId;
        mode?: SheetMode;
        animation?:
            | "spring"
            | "tween"
            | "ios-spring"
            | "material-bounce"
            | "linear"
            | "snappy";
        spring?: { stiffness?: number; damping?: number; mass?: number };
        focusTrap?: boolean;
        closeOnEscape?: boolean;
        closeOnBack?: boolean;
        lockBodyScroll?: boolean;
        rubberBand?: boolean;
        backdropRange?: [number, number];
        radius?: string | number;
        maxHeight?: string | number;
        persistent?: boolean;
        disableClose?: boolean;
        disableDrag?: boolean;
        dragFrom?: EngineOptions["dragFrom"];
        dragFromContent?: boolean;
        fitContentToSnap?: boolean;
        closeOnRouteChange?: boolean;
        stackEffect?: boolean;
        teleport?: boolean;
        teleportTo?: TeleportTarget;
        returnFocusTo?: EngineOptions["returnFocusTo"];
        backdrop?: boolean;
        closeOnBackdrop?: boolean;
        ariaLabel?: string;
        onSnap?: (id: TId) => void;
        onBeforeSnap?: (payload: SheetEventMap["before-snap"]) => void;
        onBeforeClose?: (payload: SheetEventMap["before-close"]) => void;
        onOpen?: (id: TId) => void;
        onClose?: () => void;
        onOpened?: (id: TId) => void;
        onClosed?: () => void;
        onDragStart?: (payload: SheetEventMap["dragstart"]) => void;
        onDragEnd?: (payload: SheetEventMap["dragend"]) => void;
        onDrag?: (payload: SheetEventMap["drag"]) => void;
        onProgress?: (payload: SheetEventMap["progress"]) => void;
        onChange?: (state: EngineState & { activeId: TId }) => void;
        engineRef?: (engine: BottomSheetEngine | null) => void;
        header?: JSX.Element;
        footer?: JSX.Element;
        leftButton?: JSX.Element;
        rightButton?: JSX.Element;
        screen?: JSX.Element;
        children?: JSX.Element;
    }

    Type Parameters

    • TId extends string = string
    Index
    snapPoints: SnapPointDef<TId>[] | ReadonlyArray<SnapPointDef<TId>>
    allowed?: TId[] | ReadonlyArray<TId>
    initial?: TId
    mode?: SheetMode
    animation?:
        | "spring"
        | "tween"
        | "ios-spring"
        | "material-bounce"
        | "linear"
        | "snappy"
    spring?: { stiffness?: number; damping?: number; mass?: number }
    focusTrap?: boolean
    closeOnEscape?: boolean
    closeOnBack?: boolean
    lockBodyScroll?: boolean
    rubberBand?: boolean
    backdropRange?: [number, number]
    radius?: string | number
    maxHeight?: string | number
    persistent?: boolean
    disableClose?: boolean
    disableDrag?: boolean
    dragFromContent?: boolean
    fitContentToSnap?: boolean
    closeOnRouteChange?: boolean
    stackEffect?: boolean
    teleport?: boolean
    teleportTo?: TeleportTarget
    backdrop?: boolean
    closeOnBackdrop?: boolean
    ariaLabel?: string
    onSnap?: (id: TId) => void
    onBeforeSnap?: (payload: SheetEventMap["before-snap"]) => void
    onBeforeClose?: (payload: SheetEventMap["before-close"]) => void
    onOpen?: (id: TId) => void
    onClose?: () => void
    onOpened?: (id: TId) => void
    onClosed?: () => void
    onDragStart?: (payload: SheetEventMap["dragstart"]) => void
    onDragEnd?: (payload: SheetEventMap["dragend"]) => void
    onDrag?: (payload: SheetEventMap["drag"]) => void
    onProgress?: (payload: SheetEventMap["progress"]) => void
    onChange?: (state: EngineState & { activeId: TId }) => void
    engineRef?: (engine: BottomSheetEngine | null) => void
    header?: JSX.Element
    footer?: JSX.Element
    leftButton?: JSX.Element
    rightButton?: JSX.Element
    screen?: JSX.Element
    children?: JSX.Element