@surdeddd/bottom-sheet 0.12.0 → 0.14.0

package/dist/solid.d.cts

@@ -1,13 +1,18 @@
 import { JSX } from 'solid-js';
 
+type DragFrom$1 = "handle" | "sheet" | "zones";
+
 type TransformAxis = "bottom" | "top" | "left" | "right";
 
 type SnapPoint = number | `${number}%` | "fit" | "content" | "full" | (string & {});
 type SnapPointDef<Id extends string = string> = {
     id: Id;
     size: SnapPoint;
+    dragFromContent?: boolean;
 };
 type SheetMode = TransformAxis;
+type DragFrom = DragFrom$1;
+type DragSurfaceKind = "content";
 type ScrimPreset = "subtle" | "standard" | "monitoring" | "cinematic";
 type ScrimUpdate = {
     color?: string | null;
@@ -83,6 +88,8 @@ type EngineOptions = {
     respectReducedMotion?: boolean;
     flickVelocity?: number;
     dragThreshold?: number;
+    dragFrom?: DragFrom;
+    dragFromContent?: boolean;
     rubberBand?: boolean;
     backdropRange?: [number, number];
     screenRange?: [number, number];
@@ -93,6 +100,7 @@ type EngineOptions = {
     scrimTapToClose?: boolean;
     scrimPreset?: ScrimPreset;
     animation?: "spring" | "tween" | "ios-spring" | "material-bounce" | "linear" | "snappy";
+    settleAnimation?: "waapi";
     spring?: {
         stiffness?: number;
         damping?: number;
@@ -117,15 +125,65 @@ type EngineOptions = {
     linkedSheets?: BottomSheetEngineLike[];
     viewTransitions?: boolean;
     stackEffect?: boolean;
+    features?: EngineFeature[];
 };
 
-type BottomSheetEngineLike = BottomSheetEngine;
+type BottomSheetEngineLike = BottomSheetCore;
+type EngineFeatureStage = "attach" | "post";
+type EngineFeatureOptions = {
+    routedTo?: string;
+    closeOnBack: boolean;
+    closeOnRouteChange: boolean;
+    persistKey?: string;
+    autoCollapseAfter?: number;
+};
+type EngineFeatureContext = {
+    element: HTMLElement;
+    scrollContainer?: HTMLElement;
+    sheetId: string;
+    options: EngineFeatureOptions;
+    isDestroyed: () => boolean;
+    isDragging: () => boolean;
+    isAnimating: () => boolean;
+    isTopSheet: () => boolean;
+    isVerticalAxis: () => boolean;
+    getSize: () => number;
+    getActiveId: () => string;
+    getAllowedIds: () => string[];
+    allowedIdsBySize: () => string[];
+    getMaxAxisSize: () => number;
+    resolveSnap: (id: string) => {
+        id: string;
+        size: number;
+    } | null;
+    resolveActiveSnap: () => {
+        id: string;
+        size: number;
+    } | null;
+    setSize: (size: number) => void;
+    setMaxAxisSize: (size: number) => void;
+    applySize: (size: number) => void;
+    recomputeSnaps: () => void;
+    newCycle: () => void;
+    cancelInFlight: () => void;
+    resyncAfterResize: () => void;
+    snapTo: (id: string) => void;
+    close: (reason?: CloseReason) => Promise<void>;
+    attachDragSurface: (surface: HTMLElement, kind: DragSurfaceKind) => (() => void) | void;
+    on: <K extends keyof SheetEventMap>(event: K, fn: (payload: SheetEventMap[K]) => void) => () => void;
+    addTeardown: (fn: (() => void) | null | undefined) => void;
+};
+type EngineFeature = {
+    name: string;
+    stage?: EngineFeatureStage;
+    install: (ctx: EngineFeatureContext) => (() => void) | void;
+};
 type TeardownScope = {
     add: (fn: (() => void) | null | undefined) => void;
 };
 type Plugin = {
     name: string;
-    install: (engine: BottomSheetEngine, scope: TeardownScope) => void | (() => void);
+    install: (engine: BottomSheetCore, scope: TeardownScope) => void | (() => void);
 };
 type EngineState = {
     size: number;
@@ -180,7 +238,7 @@ type ScrimStagesOptions = {
 };
 
 type Listener<K extends keyof SheetEventMap> = (payload: SheetEventMap[K]) => void;
-declare class BottomSheetEngine {
+declare class BottomSheetCore {
     private id;
     private element;
     private handle;
@@ -191,6 +249,8 @@ declare class BottomSheetEngine {
     private mode;
     private flickVelocity;
     private dragThreshold;
+    private dragFromMode;
+    private dragFromContentDefault;
     private rubberBandEnabled;
     private scrim;
     private aria;
@@ -208,8 +268,11 @@ declare class BottomSheetEngine {
     private activeId;
     private size;
     private gesture;
+    private contentGesture;
+    private detachSheetGesture;
     private rootEl;
     private destroyed;
+    private restClosed;
     private currentViewTransition;
     private currentAbort;
     private sizeWriteSentinel;
@@ -232,11 +295,16 @@ declare class BottomSheetEngine {
     private stackEffectPrimed;
     private fitDeps;
     private transformTemplate;
+    private featureList;
+    private featureCtx;
     constructor(opts: EngineOptions);
+    private buildFeatureContext;
+    private runFeatureStage;
+    private warnOrphanFeatureOptions;
     get state(): EngineState;
     on<K extends keyof SheetEventMap>(event: K, fn: Listener<K>): () => void;
     use(plugin: Plugin): this;
-    setLinkedSheets(sheets: BottomSheetEngine[]): void;
+    setLinkedSheets(sheets: BottomSheetCore[]): void;
     getAllowedIds(): string[];
     getResolvedSnaps(): readonly {
         id: string;
@@ -247,6 +315,7 @@ declare class BottomSheetEngine {
         signal?: AbortSignal;
     }, _skipBeforeSnap?: boolean): Promise<void>;
     private completeSnap;
+    private setRestClosed;
     private emitOpenSequence;
     private emitCloseSequence;
     dragTo(targetSize: number, velocityOrOpts?: number | {
@@ -259,6 +328,9 @@ declare class BottomSheetEngine {
     setPersistent(value: boolean): void;
     setDisableClose(value: boolean): void;
     setDisableDrag(value: boolean): void;
+    setDragFromContent(value: boolean): void;
+    setDragFrom(mode: DragFrom$1): void;
+    getDragFrom(): DragFrom$1;
     isTop(): boolean;
     depth(): number;
     expand(): Promise<void>;
@@ -298,9 +370,17 @@ declare class BottomSheetEngine {
     private updateAriaSlider;
     private registerInStack;
     private applyStackDepth;
+    private buildGestureDeps;
+    private isContentDragAllowed;
+    private decideContentDrag;
+    private attachDragSurface;
+    private sheetDragSurface;
+    private canStartSheetDrag;
+    private mountSheetGesture;
     private attach;
     private attachFeatures;
     private settleAfterDrag;
+    private isDraggingAny;
     private clearWillChangeIfIdle;
     private haptic;
     private applySize;
@@ -310,6 +390,10 @@ declare class BottomSheetEngine {
     private handleClose;
 }
 
+declare class BottomSheetEngine extends BottomSheetCore {
+    constructor(opts: EngineOptions);
+}
+
 type TeleportTarget = HTMLElement | string | null | undefined;
 
 /** @jsxImportSource solid-js */
@@ -336,6 +420,8 @@ type BottomSheetProps<TId extends string = string> = {
     persistent?: boolean;
     disableClose?: boolean;
     disableDrag?: boolean;
+    dragFrom?: EngineOptions["dragFrom"];
+    dragFromContent?: boolean;
     closeOnRouteChange?: boolean;
     stackEffect?: boolean;
     teleport?: boolean;

package/dist/solid.d.ts

@@ -1,13 +1,18 @@
 import { JSX } from 'solid-js';
 
+type DragFrom$1 = "handle" | "sheet" | "zones";
+
 type TransformAxis = "bottom" | "top" | "left" | "right";
 
 type SnapPoint = number | `${number}%` | "fit" | "content" | "full" | (string & {});
 type SnapPointDef<Id extends string = string> = {
     id: Id;
     size: SnapPoint;
+    dragFromContent?: boolean;
 };
 type SheetMode = TransformAxis;
+type DragFrom = DragFrom$1;
+type DragSurfaceKind = "content";
 type ScrimPreset = "subtle" | "standard" | "monitoring" | "cinematic";
 type ScrimUpdate = {
     color?: string | null;
@@ -83,6 +88,8 @@ type EngineOptions = {
     respectReducedMotion?: boolean;
     flickVelocity?: number;
     dragThreshold?: number;
+    dragFrom?: DragFrom;
+    dragFromContent?: boolean;
     rubberBand?: boolean;
     backdropRange?: [number, number];
     screenRange?: [number, number];
@@ -93,6 +100,7 @@ type EngineOptions = {
     scrimTapToClose?: boolean;
     scrimPreset?: ScrimPreset;
     animation?: "spring" | "tween" | "ios-spring" | "material-bounce" | "linear" | "snappy";
+    settleAnimation?: "waapi";
     spring?: {
         stiffness?: number;
         damping?: number;
@@ -117,15 +125,65 @@ type EngineOptions = {
     linkedSheets?: BottomSheetEngineLike[];
     viewTransitions?: boolean;
     stackEffect?: boolean;
+    features?: EngineFeature[];
 };
 
-type BottomSheetEngineLike = BottomSheetEngine;
+type BottomSheetEngineLike = BottomSheetCore;
+type EngineFeatureStage = "attach" | "post";
+type EngineFeatureOptions = {
+    routedTo?: string;
+    closeOnBack: boolean;
+    closeOnRouteChange: boolean;
+    persistKey?: string;
+    autoCollapseAfter?: number;
+};
+type EngineFeatureContext = {
+    element: HTMLElement;
+    scrollContainer?: HTMLElement;
+    sheetId: string;
+    options: EngineFeatureOptions;
+    isDestroyed: () => boolean;
+    isDragging: () => boolean;
+    isAnimating: () => boolean;
+    isTopSheet: () => boolean;
+    isVerticalAxis: () => boolean;
+    getSize: () => number;
+    getActiveId: () => string;
+    getAllowedIds: () => string[];
+    allowedIdsBySize: () => string[];
+    getMaxAxisSize: () => number;
+    resolveSnap: (id: string) => {
+        id: string;
+        size: number;
+    } | null;
+    resolveActiveSnap: () => {
+        id: string;
+        size: number;
+    } | null;
+    setSize: (size: number) => void;
+    setMaxAxisSize: (size: number) => void;
+    applySize: (size: number) => void;
+    recomputeSnaps: () => void;
+    newCycle: () => void;
+    cancelInFlight: () => void;
+    resyncAfterResize: () => void;
+    snapTo: (id: string) => void;
+    close: (reason?: CloseReason) => Promise<void>;
+    attachDragSurface: (surface: HTMLElement, kind: DragSurfaceKind) => (() => void) | void;
+    on: <K extends keyof SheetEventMap>(event: K, fn: (payload: SheetEventMap[K]) => void) => () => void;
+    addTeardown: (fn: (() => void) | null | undefined) => void;
+};
+type EngineFeature = {
+    name: string;
+    stage?: EngineFeatureStage;
+    install: (ctx: EngineFeatureContext) => (() => void) | void;
+};
 type TeardownScope = {
     add: (fn: (() => void) | null | undefined) => void;
 };
 type Plugin = {
     name: string;
-    install: (engine: BottomSheetEngine, scope: TeardownScope) => void | (() => void);
+    install: (engine: BottomSheetCore, scope: TeardownScope) => void | (() => void);
 };
 type EngineState = {
     size: number;
@@ -180,7 +238,7 @@ type ScrimStagesOptions = {
 };
 
 type Listener<K extends keyof SheetEventMap> = (payload: SheetEventMap[K]) => void;
-declare class BottomSheetEngine {
+declare class BottomSheetCore {
     private id;
     private element;
     private handle;
@@ -191,6 +249,8 @@ declare class BottomSheetEngine {
     private mode;
     private flickVelocity;
     private dragThreshold;
+    private dragFromMode;
+    private dragFromContentDefault;
     private rubberBandEnabled;
     private scrim;
     private aria;
@@ -208,8 +268,11 @@ declare class BottomSheetEngine {
     private activeId;
     private size;
     private gesture;
+    private contentGesture;
+    private detachSheetGesture;
     private rootEl;
     private destroyed;
+    private restClosed;
     private currentViewTransition;
     private currentAbort;
     private sizeWriteSentinel;
@@ -232,11 +295,16 @@ declare class BottomSheetEngine {
     private stackEffectPrimed;
     private fitDeps;
     private transformTemplate;
+    private featureList;
+    private featureCtx;
     constructor(opts: EngineOptions);
+    private buildFeatureContext;
+    private runFeatureStage;
+    private warnOrphanFeatureOptions;
     get state(): EngineState;
     on<K extends keyof SheetEventMap>(event: K, fn: Listener<K>): () => void;
     use(plugin: Plugin): this;
-    setLinkedSheets(sheets: BottomSheetEngine[]): void;
+    setLinkedSheets(sheets: BottomSheetCore[]): void;
     getAllowedIds(): string[];
     getResolvedSnaps(): readonly {
         id: string;
@@ -247,6 +315,7 @@ declare class BottomSheetEngine {
         signal?: AbortSignal;
     }, _skipBeforeSnap?: boolean): Promise<void>;
     private completeSnap;
+    private setRestClosed;
     private emitOpenSequence;
     private emitCloseSequence;
     dragTo(targetSize: number, velocityOrOpts?: number | {
@@ -259,6 +328,9 @@ declare class BottomSheetEngine {
     setPersistent(value: boolean): void;
     setDisableClose(value: boolean): void;
     setDisableDrag(value: boolean): void;
+    setDragFromContent(value: boolean): void;
+    setDragFrom(mode: DragFrom$1): void;
+    getDragFrom(): DragFrom$1;
     isTop(): boolean;
     depth(): number;
     expand(): Promise<void>;
@@ -298,9 +370,17 @@ declare class BottomSheetEngine {
     private updateAriaSlider;
     private registerInStack;
     private applyStackDepth;
+    private buildGestureDeps;
+    private isContentDragAllowed;
+    private decideContentDrag;
+    private attachDragSurface;
+    private sheetDragSurface;
+    private canStartSheetDrag;
+    private mountSheetGesture;
     private attach;
     private attachFeatures;
     private settleAfterDrag;
+    private isDraggingAny;
     private clearWillChangeIfIdle;
     private haptic;
     private applySize;
@@ -310,6 +390,10 @@ declare class BottomSheetEngine {
     private handleClose;
 }
 
+declare class BottomSheetEngine extends BottomSheetCore {
+    constructor(opts: EngineOptions);
+}
+
 type TeleportTarget = HTMLElement | string | null | undefined;
 
 /** @jsxImportSource solid-js */
@@ -336,6 +420,8 @@ type BottomSheetProps<TId extends string = string> = {
     persistent?: boolean;
     disableClose?: boolean;
     disableDrag?: boolean;
+    dragFrom?: EngineOptions["dragFrom"];
+    dragFromContent?: boolean;
     closeOnRouteChange?: boolean;
     stackEffect?: boolean;
     teleport?: boolean;