@surdeddd/bottom-sheet 0.1.0 → 0.2.0

package/dist/integrations/formik.d.cts

@@ -1,5 +1,5 @@
-import { d as SheetEventMap } from '../BottomSheetEngine-CvSVbo6c.cjs';
-import '../transform-Brkf-wzo.cjs';
+import { d as SheetEventMap } from '../BottomSheetEngine-CIT9Htti.cjs';
+import '../transform-jVfAikE9.cjs';
 
 type FormikStateLike = {
     dirty: boolean;
@@ -16,12 +16,6 @@ type SheetGuardRef = {
 type FormikRefLike = {
     current: FormikStateLike | null | undefined;
 };
-/**
- * Formik counterpart to useFormGuard — takes a `ref<FormikProps>` because
- * Formik's render-prop API doesn't surface props at hook-call time the way
- * useForm() does. Use `<Formik innerRef={formikRef}>` or stash `useFormik()`
- * on a ref yourself.
- */
 declare function useFormikGuard<Values extends Record<string, unknown> = Record<string, unknown>>(sheetRef: SheetGuardRef, formikRef: FormikRefLike, _tag?: Values): void;
 
 export { type FormikRefLike, type FormikStateLike, type SheetEventTarget, type SheetGuardRef, useFormikGuard };

package/dist/integrations/formik.d.ts

@@ -1,5 +1,5 @@
-import { d as SheetEventMap } from '../BottomSheetEngine-DbO8rW_3.js';
-import '../transform-Brkf-wzo.js';
+import { d as SheetEventMap } from '../BottomSheetEngine-Df9MwBbm.js';
+import '../transform-jVfAikE9.js';
 
 type FormikStateLike = {
     dirty: boolean;
@@ -16,12 +16,6 @@ type SheetGuardRef = {
 type FormikRefLike = {
     current: FormikStateLike | null | undefined;
 };
-/**
- * Formik counterpart to useFormGuard — takes a `ref<FormikProps>` because
- * Formik's render-prop API doesn't surface props at hook-call time the way
- * useForm() does. Use `<Formik innerRef={formikRef}>` or stash `useFormik()`
- * on a ref yourself.
- */
 declare function useFormikGuard<Values extends Record<string, unknown> = Record<string, unknown>>(sheetRef: SheetGuardRef, formikRef: FormikRefLike, _tag?: Values): void;
 
 export { type FormikRefLike, type FormikStateLike, type SheetEventTarget, type SheetGuardRef, useFormikGuard };

package/dist/integrations/react-hook-form.d.cts

@@ -1,5 +1,5 @@
-import { d as SheetEventMap } from '../BottomSheetEngine-CvSVbo6c.cjs';
-import '../transform-Brkf-wzo.cjs';
+import { d as SheetEventMap } from '../BottomSheetEngine-CIT9Htti.cjs';
+import '../transform-jVfAikE9.cjs';
 
 type RhfFormStateLike = {
     formState: {
@@ -16,15 +16,6 @@ type SheetGuardRef = {
 } | {
     readonly current: SheetEventTarget | null | undefined;
 };
-/**
- * Gates close attempts behind react-hook-form's `isDirty` / `isSubmitting`.
- * Cancels closing while the form is dirty (consumer prompts then re-calls
- * close) and cancels every snap while submit is in flight.
- *
- * The `methods` argument is read through a ref refreshed each render, so a
- * freshly-constructed `useForm()` return on each parent render is safe —
- * the listener always reads live form state, never a closure-captured one.
- */
 declare function useFormGuard<TFieldValues extends Record<string, unknown> = Record<string, unknown>>(sheetRef: SheetGuardRef, methods: RhfFormStateLike, _tag?: TFieldValues): void;
 
 export { type RhfFormStateLike, type SheetEventTarget, type SheetGuardRef, useFormGuard };

package/dist/integrations/react-hook-form.d.ts

@@ -1,5 +1,5 @@
-import { d as SheetEventMap } from '../BottomSheetEngine-DbO8rW_3.js';
-import '../transform-Brkf-wzo.js';
+import { d as SheetEventMap } from '../BottomSheetEngine-Df9MwBbm.js';
+import '../transform-jVfAikE9.js';
 
 type RhfFormStateLike = {
     formState: {
@@ -16,15 +16,6 @@ type SheetGuardRef = {
 } | {
     readonly current: SheetEventTarget | null | undefined;
 };
-/**
- * Gates close attempts behind react-hook-form's `isDirty` / `isSubmitting`.
- * Cancels closing while the form is dirty (consumer prompts then re-calls
- * close) and cancels every snap while submit is in flight.
- *
- * The `methods` argument is read through a ref refreshed each render, so a
- * freshly-constructed `useForm()` return on each parent render is safe —
- * the listener always reads live form state, never a closure-captured one.
- */
 declare function useFormGuard<TFieldValues extends Record<string, unknown> = Record<string, unknown>>(sheetRef: SheetGuardRef, methods: RhfFormStateLike, _tag?: TFieldValues): void;
 
 export { type RhfFormStateLike, type SheetEventTarget, type SheetGuardRef, useFormGuard };

package/dist/overlay.cjs

@@ -282,12 +282,8 @@ var LifecycleController = class {
     __publicField(this, "inertSiblings");
     __publicField(this, "shouldApplyInertSiblings");
     __publicField(this, "returnFocus");
-    /** Toggle-state teardowns — fire on close, NOT in destroy-only stack. */
     __publicField(this, "releaseFocusTrap", null);
     __publicField(this, "releaseScrollLock", null);
-    /** True between install() and release(). Guards release()/destroy() from
-     *  re-running side effects (notably `returnFocus.focus()`) on already-
-     *  released or never-installed instances. */
     __publicField(this, "installed", false);
     __publicField(this, "destroyed", false);
     this.element = deps.element;
@@ -301,14 +297,6 @@ var LifecycleController = class {
     this.returnFocus = opts.returnFocus;
     this.inertSiblings = createInertSiblings(() => this.element);
   }
-  /**
-   * Run the open-time install steps. Idempotent: each step checks its
-   * existing teardown ref so a re-open during a half-cancelled close
-   * doesn't double-install. Sets `installed=true` BEFORE the first side
-   * effect so a partial throw (detached / shadow-DOM target) leaves the
-   * caller's `release()` rollback path armed to undo whatever did succeed.
-   * No-op when destroyed.
-   */
   install() {
     if (this.destroyed) return;
     this.installed = true;
@@ -325,22 +313,10 @@ var LifecycleController = class {
       this.inertSiblings.apply();
     }
   }
-  /**
-   * Update the post-release focus target. Overlay re-binds this when the
-   * consumer changes `returnFocus` after construction; the new value applies
-   * on the next `release()`. No-op when destroyed.
-   */
   setReturnFocus(target) {
     if (this.destroyed) return;
     this.returnFocus = target;
   }
-  /**
-   * Release all install-time teardowns. Short-circuits when not installed,
-   * so `close() → destroy()` (each routing through here) only restores
-   * focus once. The `installed` guard lets `inertSiblings.remove()` and
-   * the focus-trap/scroll-lock teardown nullings stay simple — they were
-   * already idempotent, but `returnFocus.focus()` was firing on every call.
-   */
   release() {
     if (!this.installed) return;
     this.installed = false;
@@ -354,12 +330,6 @@ var LifecycleController = class {
       target?.focus?.();
     }
   }
-  /**
-   * Final teardown — releases any still-installed listeners and seals the
-   * controller. After destroy(), install() is a no-op and setReturnFocus()
-   * is rejected, so post-destroy mutations can't queue up a stale focus
-   * restore.
-   */
   destroy() {
     this.release();
     this.destroyed = true;
@@ -431,8 +401,6 @@ var OverlayEngine = class {
     __publicField(this, "exitEasing");
     __publicField(this, "backdropOpacity");
     __publicField(this, "backdropFilter");
-    // Definite-assignment: written via assignSwipeFromConfig in the
-    // constructor — TS can't follow the helper, mark the assertion explicit.
     __publicField(this, "swipeToCloseEnabled");
     __publicField(this, "swipeThreshold");
     __publicField(this, "swipeVelocityThreshold");
@@ -452,13 +420,7 @@ var OverlayEngine = class {
     __publicField(this, "isOpen_", false);
     __publicField(this, "isAnimating_", false);
     __publicField(this, "destroyed", false);
-    // Tracks whether setOverlayChildren ever populated the panel — lets
-    // clearOverlayChildren skip the DOM mutation when nothing was injected
-    // (so the field also acts as a zero-allocation feature flag).
     __publicField(this, "hasInjectedChildren", false);
-    // Bumped on every open/close. awaitTransition captures it and ignores
-    // transitionend/timeout fired by older cycles — prevents cross-cycle
-    // listener bleed during rapid toggling.
     __publicField(this, "cycleNonce", 0);
     __publicField(this, "bus", createEventBus());
     __publicField(this, "detachEscape", null);
@@ -511,9 +473,6 @@ var OverlayEngine = class {
         closeOnEscape: this.closeOnEscape,
         lockBodyScroll: this.bodyScrollLockEnabled,
         inertSiblings: this.inertSiblingsEnabled,
-        // Overlay-specific guard: only paint body siblings inert when the
-        // overlay element is actually a body descendant. Detached / shadow-
-        // DOM / portal overlays would otherwise lock unrelated trees.
         shouldApplyInertSiblings: () => {
           const bodyChildren = Array.from(document.body.children);
           return bodyChildren.some(
@@ -667,12 +626,6 @@ var OverlayEngine = class {
     this.releaseStackEntry = null;
     this.restoreMount();
   }
-  /**
-   * Runtime visual setter — opacity is applied immediately when open so a
-   * live-controls panel can preview the change without re-opening. When
-   * closed we only stash the field; next open() picks it up so we don't
-   * mutate hidden DOM (avoids paint thrash on detached panels).
-   */
   setBackdropOpacity(opacity) {
     if (this.destroyed) return;
     this.backdropOpacity = opacity;
@@ -680,11 +633,6 @@ var OverlayEngine = class {
       this.backdrop.style.opacity = String(opacity);
     }
   }
-  /**
-   * Runtime visual setter for `backdrop-filter`. `undefined` clears the
-   * filter (mirrors the close() behaviour). Defers to next open() when the
-   * overlay is currently closed.
-   */
   setBackdropFilter(filter) {
     if (this.destroyed) return;
     this.backdropFilter = filter;
@@ -698,12 +646,6 @@ var OverlayEngine = class {
       style.webkitBackdropFilter = "";
     }
   }
-  /**
-   * Toggle / reconfigure swipe-to-close at runtime. Re-resolves the flat
-   * threshold fields, then installs or tears down the pointer listener so
-   * the change applies to the CURRENT open cycle. Idempotent: safe to call
-   * with the same config repeatedly.
-   */
   setSwipeToClose(config) {
     if (this.destroyed) return;
     const wasEnabled = this.swipeToCloseEnabled;
@@ -716,7 +658,6 @@ var OverlayEngine = class {
       this.detachSwipe = null;
     }
   }
-  /** Animation setters only stage the field — applied on next open/close. */
   setEnterAnimation(animation) {
     if (this.destroyed) return;
     this.enterAnimation = animation;
@@ -725,23 +666,15 @@ var OverlayEngine = class {
     if (this.destroyed) return;
     this.exitAnimation = animation;
   }
-  /** Updates the field used at next close() — no immediate side effect. */
   setReturnFocus(target) {
     if (this.destroyed) return;
     this.lifecycle.setReturnFocus(target);
   }
-  /**
-   * Batch update — preset first, then individual overrides. Applied as a
-   * single DOM-write phase when open so live-controls don't trigger
-   * cascading reflows. Safe to call when closed (defers to next open).
-   */
   setOverlay(opts) {
     if (this.destroyed) return;
     const preset = opts.preset ? OVERLAY_PRESETS[opts.preset] : void 0;
     const merged = preset ? {
       backdropOpacity: preset.backdropOpacity,
-      // Preset's `undefined` filter means "no filter" — surface as null
-      // so the merged step clears the field instead of inheriting old.
       backdropFilter: preset.backdropFilter === void 0 ? null : preset.backdropFilter,
       swipeToClose: preset.swipeToClose,
       enterAnimation: preset.enterAnimation,
@@ -800,30 +733,17 @@ var OverlayEngine = class {
       }
     }
   }
-  /**
-   * Runtime children injection — replace the panel's contents without
-   * unmounting the engine. `replaceChildren()` is a single atomic DOM op,
-   * so callers can swap content rapidly without intermediate flicker.
-   * Function form is resolved exactly ONCE per call (cheap lazy content).
-   */
   setOverlayChildren(children) {
     if (this.destroyed) return;
     const node = typeof children === "function" ? children() : children;
     this.element.replaceChildren(node);
     this.hasInjectedChildren = true;
   }
-  /**
-   * Clear injected children. No-op when nothing was injected so consumers
-   * who never used setOverlayChildren can call this defensively without
-   * paying for a DOM mutation.
-   */
   clearOverlayChildren() {
     if (this.destroyed || !this.hasInjectedChildren) return;
     this.element.replaceChildren();
     this.hasInjectedChildren = false;
   }
-  // Shared swipe-config normalizer — used by constructor, setSwipeToClose,
-  // and setOverlay so the union/object shape is decoded in exactly one place.
   assignSwipeFromConfig(swipe) {
     if (typeof swipe === "object" && swipe !== null) {
       this.swipeToCloseEnabled = swipe.enabled ?? true;
@@ -967,13 +887,6 @@ var OverlayEngine = class {
     this.detachOutsidePointer = null;
     this.lifecycle.release();
   }
-  /**
-   * Light pointer-driven dismiss. Tracks finger along the edge axis, follows
-   * with translate, dismisses if past `swipeThreshold` (fraction of panel
-   * size) or release velocity exceeds `swipeVelocityThreshold` (px/ms).
-   * Pure CSS-transform during drag — no rAF or physics required since the
-   * panel only moves one direction.
-   */
   installSwipeToClose() {
     const el = this.element;
     const edge = this.edge;

package/dist/overlay.d.cts

@@ -1,13 +1,5 @@
-import { T as TransformAxis } from './transform-Brkf-wzo.cjs';
+import { T as TransformAxis } from './transform-jVfAikE9.cjs';
 
-/**
- * Slide-up panel without gestures. CSS-transition-driven, single-state.
- * Distinct from `BottomSheetEngine`, which is gesture-driven and multi-snap.
- *
- * Shares scroll-lock / focus-trap / sheet-stack / inert-siblings / transform
- * primitives with the engine so z-indices orchestrate automatically when
- * sheets and overlays mix and feature behaviour stays consistent.
- */
 type OverlayEdge = TransformAxis;
 type OverlayAnimation = "slide" | "fade" | "scale";
 type OverlayCloseReason = "escape" | "backdrop" | "swipe" | "back" | "programmatic" | "outside-pointer";
@@ -17,12 +9,6 @@ type SwipeToCloseConfig = {
     velocityThreshold?: number;
 };
 type OverlayMountTarget = HTMLElement | "body" | "parent";
-/**
- * Named overlay archetypes — bundle the common animation + dim + gesture
- * combinations so consumers can opt into a "mode" without restating every
- * field. Applied BEFORE individual options at construction, and as the
- * first step of `setOverlay()` so individual overrides win.
- */
 type OverlayPreset = "sheet" | "dialog" | "sidebar" | "toast";
 type OverlayPresetConfig = {
     enterAnimation: OverlayAnimation;
@@ -32,12 +18,6 @@ type OverlayPresetConfig = {
     swipeToClose: boolean | SwipeToCloseConfig;
 };
 declare const OVERLAY_PRESETS: Readonly<Record<OverlayPreset, Readonly<OverlayPresetConfig>>>;
-/**
- * Batch payload for `setOverlay()`. `null` on `backdropFilter` clears it
- * (distinct from `undefined` which means "leave as-is" in the diff). Apply
- * order: preset first, then individual overrides — single DOM-write phase
- * if the overlay is currently open.
- */
 type OverlayUpdate = {
     backdropOpacity?: number;
     backdropFilter?: string | null;
@@ -45,107 +25,33 @@ type OverlayUpdate = {
     enterAnimation?: OverlayAnimation;
     exitAnimation?: OverlayAnimation;
     preset?: OverlayPreset;
-    /**
-     * Runtime children swap. `null` clears the panel's contents. A function is
-     * called once to lazy-resolve dynamic content. Applied LAST in the batch so
-     * style mutations finish before the DOM swap.
-     */
     children?: HTMLElement | DocumentFragment | (() => HTMLElement | DocumentFragment) | null;
 };
 type OverlayOptions = {
-    /** The panel element — gets transform/opacity inline writes. */
     element: HTMLElement;
-    /** Optional dimmed backdrop element. */
     backdrop?: HTMLElement;
-    /** Edge the panel slides in from. Default: "bottom". */
     edge?: OverlayEdge;
-    /** Open immediately on construction. Default: false. */
     initialOpen?: boolean;
-    /** Listen for Escape key. Default: true. */
     closeOnEscape?: boolean;
-    /** Tap on backdrop closes. Default: true. */
     closeOnBackdrop?: boolean;
-    /** Trap Tab focus inside the panel. Default: true. */
     focusTrap?: boolean;
-    /** Selector or HTMLElement focused on open. */
     initialFocus?: string | HTMLElement;
-    /**
-     * Element to focus after close. By default the focus trap restores
-     * whatever was focused before open. Pass an element or a getter for
-     * explicit control (e.g. focus a status banner instead of the trigger).
-     */
     returnFocus?: HTMLElement | (() => HTMLElement | null);
-    /** Lock body scroll while open. Default: true. */
     lockBodyScroll?: boolean;
-    /** Mark page siblings `inert` while open (full a11y modal). Default: false. */
     inertSiblings?: boolean;
-    /** Push history state so Android back closes the overlay. Default: false. */
     closeOnBack?: boolean;
-    /** Animation duration in ms. Default: 320. */
     duration?: number;
-    /** CSS easing for the slide-in. Default matches monitoring's bezier. */
     enterEasing?: string;
-    /** CSS easing for the slide-out. Default: ease-in. */
     exitEasing?: string;
-    /**
-     * Peak backdrop opacity when open. Useful when `backdropFilter` blur
-     * already darkens enough and the dim should be light (e.g. 0.3).
-     * Default: 1.
-     */
     backdropOpacity?: number;
-    /**
-     * CSS `backdrop-filter` value applied to the backdrop while open
-     * (e.g. `"blur(8px)"`, `"blur(12px) saturate(140%)"`). Cleared on close.
-     */
     backdropFilter?: string;
-    /**
-     * Allow drag-to-dismiss along the entry edge — pointer-driven. The panel
-     * follows the finger past the closed-edge axis and dismisses if the user
-     * crosses 30% of the panel size or releases with > 0.5 px/ms velocity.
-     *
-     * Pass a config object to tune thresholds:
-     *   `{ enabled: true, threshold: 0.5, velocityThreshold: 1.0 }`.
-     * Default: false (CSS-only transition).
-     */
     swipeToClose?: boolean | SwipeToCloseConfig;
-    /**
-     * Entry animation. `"slide"` (default) translates from the edge.
-     * `"fade"` is opacity-only (no transform). `"scale"` fades + scales
-     * from 0.94 — best for centred dialogs.
-     */
     enterAnimation?: OverlayAnimation;
-    /** Exit animation. Defaults to `enterAnimation`. */
     exitAnimation?: OverlayAnimation;
-    /**
-     * Move `element` to a different container on first open. `'parent'`
-     * (default) leaves it in place. `'body'` appends to `document.body`.
-     * Pass an explicit `HTMLElement` for any other portal target.
-     *
-     * Restored to its original parent on `destroy()`. Move is deferred to
-     * first `open()` so SSR / pre-mount construction doesn't crash.
-     */
     mountTo?: OverlayMountTarget;
-    /**
-     * `peek` keeps part of the panel visible when closed instead of
-     * translating fully off-screen. Number is treated as pixels; strings
-     * accept any CSS length (`"10dvh"`, `"clamp(40px, 8vh, 80px)"`).
-     * Only honoured when `edge: 'bottom'` — warns and falls back otherwise.
-     */
     peek?: number | string;
-    /**
-     * Close when a pointerdown lands outside `element` AND outside `backdrop`.
-     * Distinct from `closeOnBackdrop` — this fires even when no backdrop is
-     * mounted. Single document-level listener, removed on close.
-     */
     closeOnOutsidePointer?: boolean;
-    /**
-     * Named archetype — bundles `enterAnimation`/`exitAnimation`/
-     * `backdropOpacity`/`backdropFilter`/`swipeToClose` defaults. Applied
-     * BEFORE the individual options on this object, so any explicit field
-     * still wins over the preset's default.
-     */
     preset?: OverlayPreset;
-    /** Lifecycle callbacks. */
     onOpen?: () => void;
     onClose?: () => void;
 };
@@ -213,49 +119,14 @@ declare class OverlayEngine {
     close(reason?: OverlayCloseReason): Promise<void>;
     toggle(): Promise<void>;
     destroy(): void;
-    /**
-     * Runtime visual setter — opacity is applied immediately when open so a
-     * live-controls panel can preview the change without re-opening. When
-     * closed we only stash the field; next open() picks it up so we don't
-     * mutate hidden DOM (avoids paint thrash on detached panels).
-     */
     setBackdropOpacity(opacity: number): void;
-    /**
-     * Runtime visual setter for `backdrop-filter`. `undefined` clears the
-     * filter (mirrors the close() behaviour). Defers to next open() when the
-     * overlay is currently closed.
-     */
     setBackdropFilter(filter: string | undefined): void;
-    /**
-     * Toggle / reconfigure swipe-to-close at runtime. Re-resolves the flat
-     * threshold fields, then installs or tears down the pointer listener so
-     * the change applies to the CURRENT open cycle. Idempotent: safe to call
-     * with the same config repeatedly.
-     */
     setSwipeToClose(config: boolean | SwipeToCloseConfig): void;
-    /** Animation setters only stage the field — applied on next open/close. */
     setEnterAnimation(animation: OverlayAnimation): void;
     setExitAnimation(animation: OverlayAnimation): void;
-    /** Updates the field used at next close() — no immediate side effect. */
     setReturnFocus(target: HTMLElement | (() => HTMLElement | null) | undefined): void;
-    /**
-     * Batch update — preset first, then individual overrides. Applied as a
-     * single DOM-write phase when open so live-controls don't trigger
-     * cascading reflows. Safe to call when closed (defers to next open).
-     */
     setOverlay(opts: OverlayUpdate): void;
-    /**
-     * Runtime children injection — replace the panel's contents without
-     * unmounting the engine. `replaceChildren()` is a single atomic DOM op,
-     * so callers can swap content rapidly without intermediate flicker.
-     * Function form is resolved exactly ONCE per call (cheap lazy content).
-     */
     setOverlayChildren(children: HTMLElement | DocumentFragment | (() => HTMLElement | DocumentFragment)): void;
-    /**
-     * Clear injected children. No-op when nothing was injected so consumers
-     * who never used setOverlayChildren can call this defensively without
-     * paying for a DOM mutation.
-     */
     clearOverlayChildren(): void;
     private assignSwipeFromConfig;
     private emit;
@@ -266,13 +137,6 @@ declare class OverlayEngine {
     private awaitTransition;
     private installInteractiveListeners;
     private releaseInteractiveListeners;
-    /**
-     * Light pointer-driven dismiss. Tracks finger along the edge axis, follows
-     * with translate, dismisses if past `swipeThreshold` (fraction of panel
-     * size) or release velocity exceeds `swipeVelocityThreshold` (px/ms).
-     * Pure CSS-transform during drag — no rAF or physics required since the
-     * panel only moves one direction.
-     */
     private installSwipeToClose;
     private registerInStack;
 }