@surdeddd/bottom-sheet 0.11.0 → 0.13.0

package/dist/solid.d.cts

@@ -93,6 +93,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 +118,64 @@ 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>;
+    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 +230,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;
@@ -232,11 +282,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;
@@ -284,6 +339,7 @@ declare class BottomSheetEngine {
     };
     setSnapPoints(points: EngineOptions["snapPoints"], allowed?: string[]): void;
     recompute(): void;
+    private healActiveSnap;
     destroy(): void;
     private emit;
     private newCycle;
@@ -309,6 +365,10 @@ declare class BottomSheetEngine {
     private handleClose;
 }
 
+declare class BottomSheetEngine extends BottomSheetCore {
+    constructor(opts: EngineOptions);
+}
+
 type TeleportTarget = HTMLElement | string | null | undefined;
 
 /** @jsxImportSource solid-js */

package/dist/solid.d.ts

@@ -93,6 +93,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 +118,64 @@ 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>;
+    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 +230,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;
@@ -232,11 +282,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;
@@ -284,6 +339,7 @@ declare class BottomSheetEngine {
     };
     setSnapPoints(points: EngineOptions["snapPoints"], allowed?: string[]): void;
     recompute(): void;
+    private healActiveSnap;
     destroy(): void;
     private emit;
     private newCycle;
@@ -309,6 +365,10 @@ declare class BottomSheetEngine {
     private handleClose;
 }
 
+declare class BottomSheetEngine extends BottomSheetCore {
+    constructor(opts: EngineOptions);
+}
+
 type TeleportTarget = HTMLElement | string | null | undefined;
 
 /** @jsxImportSource solid-js */