solid-drift 0.21.0 → 0.22.0

package/README.md

@@ -1390,6 +1390,61 @@ const scratch = createScratch(() => foil, {
 
 Options: `threshold` (fraction cleared to complete, default `0.45`), `brush` (eraser radius in px, default `26`), `paint(ctx, w, h)` (custom cover art), `onComplete`. Returns `{ cleared, done, reset }`: `cleared()` is the 0..1 fraction erased, `reset()` repaints the cover. Scratching is direct manipulation, so it works identically under reduced motion. SSR-safe: `cleared()` stays 0.
 
+### DOM utilities
+
+Everyday DOM glue, signal-native: debounced and throttled signal transforms, a persisted signal, a live media query, outside-press dismissal, body scroll locking, and infinite scroll. All SSR-safe.
+
+```tsx
+import {
+  createDebounced,
+  createThrottled,
+  createLocalStorage,
+  createMediaQuery,
+  createClickOutside,
+  createScrollLock,
+  createInfiniteScroll,
+} from "solid-drift"
+
+// Debounced search: the query waits for a 300ms pause before firing.
+const [query, setQuery] = createSignal("")
+const debounced = createDebounced(query, 300)
+createEffect(() => { if (debounced()) search(debounced()) })
+
+// Throttled scroll position: at most one update per 100ms.
+const throttledY = createThrottled(scrollY, 100)
+
+// Persisted theme, synced across tabs.
+const theme = createLocalStorage<"light" | "dark">("theme", "light")
+theme.set("dark")
+
+// Live media query.
+const wide = createMediaQuery("(min-width: 1024px)")
+
+// Dismiss a menu on outside press.
+let menu!: HTMLDivElement
+createClickOutside(() => menu, () => setOpen(false))
+
+// Lock body scroll while a modal is open (nested locks stack).
+const scroll = createScrollLock()
+createEffect(() => { modalOpen() ? scroll.lock() : scroll.unlock() })
+
+// Infinite scroll: prefetch as the sentinel approaches.
+let sentinel!: HTMLDivElement
+createInfiniteScroll(() => sentinel, {
+  onLoadMore: () => loadPage(),
+  disabled: () => !hasMore(),
+})
+<div ref={sentinel} />
+```
+
+- `createDebounced(source, delay)` returns an `Accessor<T>` that follows the source after it stops changing for `delay` ms (trailing edge).
+- `createThrottled(source, interval)` returns an `Accessor<T>` that updates at most once per `interval` ms: leading change applies immediately, the rest collapse into one trailing update.
+- `createLocalStorage<T>(key, initialValue, options?)` returns `{ value, set, remove }`: reads the stored value on creation (falling back on missing or corrupt JSON), writes through on every set, and stays in sync across tabs via the `storage` event (`sync: true` default). Custom `serialize`/`deserialize` supported. Behaves like a plain signal where storage is unavailable.
+- `createMediaQuery(query)` returns an `Accessor<boolean>` that tracks the query live (`false` on the server).
+- `createClickOutside(ref, handler, options?)` calls `handler` on `pointerdown` (default, configurable via `events`) outside the element. Shadow-DOM aware via `composedPath`. No-op on the server.
+- `createScrollLock()` returns `{ locked, lock, unlock }`: sets `document.body.style.overflow = "hidden"`, restores the previous value when the last lock releases, and reference-counts nested locks so stacked modals cannot unlock each other early. Unmounting releases the locks.
+- `createInfiniteScroll(ref, options)` observes a sentinel with IntersectionObserver and calls `onLoadMore` as it approaches the viewport (`threshold` px prefetch via `rootMargin`, default `200`). `disabled` is a reactive kill switch (e.g. `() => !hasMore()`).
+
 ### Easings
 
 Named easings: `linear`, `easeInQuad`, `easeOutQuad`, `easeInOutQuad`, `easeInCubic`, `easeOutCubic`, `easeInOutCubic`, `easeInQuart`, `easeOutQuart`, `easeInOutQuart`, `easeOutExpo`, `easeOutBack`, plus the cartoon set: `easeInBack` (anticipation dip before movement), `easeInOutBack` (wind-up, overshoot, settle), `easeOutElastic` (decaying rubber-band oscillation), `easeOutBounce` (shrinking cartoon bounces). Also `cubicBezier(x1, y1, x2, y2)` for CSS-style curves. Pass a name or a custom `(t) => number` function anywhere an easing is accepted.

package/dist/dom.d.ts

@@ -0,0 +1,163 @@
+import { type Accessor, type Setter } from "solid-js";
+type MaybeElement = () => Element | null | undefined;
+/**
+ * A signal that follows the source after it stops changing for `delay`
+ * ms. The classic search-input pattern: the UI stays live while the
+ * query signal waits for a pause before firing network requests.
+ *
+ * Trailing edge only. The pending update is cancelled on cleanup.
+ * SSR-safe: holds the source's initial value on the server.
+ *
+ * ```tsx
+ * const [query, setQuery] = createSignal("")
+ * const debounced = createDebounced(query, 300)
+ * createEffect(() => {
+ *   const q = debounced()
+ *   if (q) search(q) // fires only after a 300ms pause
+ * })
+ * ```
+ */
+export declare function createDebounced<T>(source: Accessor<T>, delay: number): Accessor<T>;
+/**
+ * A signal that follows the source at most once per `interval` ms.
+ * The first change applies immediately (leading edge); changes inside
+ * the window collapse into one trailing update. For scroll or resize
+ * handlers that feed expensive work.
+ *
+ * SSR-safe: holds the source's initial value on the server.
+ *
+ * ```tsx
+ * const throttledY = createThrottled(scrollY, 100)
+ * ```
+ */
+export declare function createThrottled<T>(source: Accessor<T>, interval: number): Accessor<T>;
+export interface LocalStorageOptions<T> {
+    /** Serialize a value. Default JSON.stringify. */
+    serialize?: (value: T) => string;
+    /** Deserialize a stored string. Default JSON.parse. */
+    deserialize?: (raw: string) => T;
+    /**
+     * React to `storage` events from other tabs. Default true: the
+     * signal stays in sync across tabs.
+     */
+    sync?: boolean;
+}
+export interface LocalStorageControls<T> {
+    value: Accessor<T>;
+    set: Setter<T>;
+    /** Remove the key from storage and reset to the initial value. */
+    remove: () => void;
+}
+/**
+ * A signal persisted to `localStorage`. Reads the stored value on
+ * creation (falling back to `initialValue` when missing or corrupt),
+ * writes through on every set, and stays in sync across tabs via the
+ * `storage` event.
+ *
+ * SSR-safe and storage-less-safe: without `window.localStorage` it
+ * behaves like a plain signal.
+ *
+ * ```tsx
+ * const theme = createLocalStorage<"light" | "dark">("theme", "light")
+ * theme.set("dark") // localStorage.theme = '"dark"'
+ * ```
+ */
+export declare function createLocalStorage<T>(key: string, initialValue: T, options?: LocalStorageOptions<T>): LocalStorageControls<T>;
+/**
+ * A boolean signal tracking a CSS media query, updating live when the
+ * query starts or stops matching. The primitive behind
+ * `usePrefersReducedMotion`, generalized.
+ *
+ * SSR-safe (and safe where `matchMedia` is missing): constant `false`.
+ *
+ * ```tsx
+ * const wide = createMediaQuery("(min-width: 1024px)")
+ * const columns = () => (wide() ? 4 : 2)
+ * ```
+ */
+export declare function createMediaQuery(query: string): Accessor<boolean>;
+export interface ClickOutsideOptions {
+    /**
+     * Events that count as "outside". Default `["pointerdown"]`: fires
+     * before `click`, so menus dismiss without a visible flash, and
+     * covers touch via Pointer Events.
+     */
+    events?: string[];
+}
+/**
+ * Call `handler` when the user interacts outside the element:
+ * dropdowns, popovers, and menus that dismiss on outside press.
+ *
+ * Listens on `window` (so it works even when the press lands on an
+ * overlaying element), ignores presses inside the ref, and cleans up
+ * on unmount. SSR-safe: no-op on the server.
+ *
+ * ```tsx
+ * let menu!: HTMLDivElement
+ * const [open, setOpen] = createSignal(false)
+ * createClickOutside(() => menu, () => setOpen(false))
+ * ```
+ */
+export declare function createClickOutside(ref: MaybeElement, handler: (event: Event) => void, options?: ClickOutsideOptions): void;
+export interface ScrollLockControls {
+    /** Whether the body scroll is currently locked. */
+    locked: Accessor<boolean>;
+    /** Lock body scroll. Nested locks stack; all must unlock. */
+    lock: () => void;
+    /** Release one lock. Restores the original overflow when empty. */
+    unlock: () => void;
+}
+/**
+ * Lock body scroll while overlays are open: modals, drawers, the
+ * bottom sheet. `overflow: hidden` goes on `document.body`, the
+ * previous value is restored when the last lock releases, and nested
+ * locks are reference-counted so two stacked modals cannot unlock
+ * each other early. Unmounting while locked releases the lock.
+ *
+ * SSR-safe: no-op on the server.
+ *
+ * ```tsx
+ * const scroll = createScrollLock()
+ * createEffect(() => {
+ *   if (modalOpen()) scroll.lock()
+ *   else scroll.unlock()
+ * })
+ * ```
+ */
+export declare function createScrollLock(): ScrollLockControls;
+export interface InfiniteScrollOptions {
+    /** Called when the sentinel approaches the viewport. */
+    onLoadMore: () => void;
+    /**
+     * Trigger distance in px before the sentinel enters: the observer's
+     * rootMargin. Default 200.
+     */
+    threshold?: number;
+    /**
+     * Reactive kill switch, e.g. `() => !hasMore()`. While true the
+     * sentinel is unobserved.
+     */
+    disabled?: Accessor<boolean>;
+}
+/**
+ * Infinite scroll: observe a sentinel element at the end of a list
+ * and call `onLoadMore` as it approaches the viewport, prefetching
+ * before the user hits the bottom.
+ *
+ * Built on IntersectionObserver with a `rootMargin` prefetch zone.
+ * SSR-safe (and safe without IntersectionObserver): never fires.
+ *
+ * ```tsx
+ * let sentinel!: HTMLDivElement
+ * const [items, setItems] = createSignal<string[]>([])
+ * const [hasMore, setHasMore] = createSignal(true)
+ * createInfiniteScroll(() => sentinel, {
+ *   onLoadMore: () => loadPage(),
+ *   disabled: () => !hasMore(),
+ * })
+ * <For each={items()}>{(item) => <Row item={item} />}</For>
+ * <div ref={sentinel} />
+ * ```
+ */
+export declare function createInfiniteScroll(ref: MaybeElement, options: InfiniteScrollOptions): void;
+export {};

package/dist/dom.js

@@ -0,0 +1,316 @@
+import { createEffect, createSignal, onCleanup, untrack, } from "solid-js";
+/* ------------------------------------------------------------------ */
+/* createDebounced                                                     */
+/* ------------------------------------------------------------------ */
+/**
+ * A signal that follows the source after it stops changing for `delay`
+ * ms. The classic search-input pattern: the UI stays live while the
+ * query signal waits for a pause before firing network requests.
+ *
+ * Trailing edge only. The pending update is cancelled on cleanup.
+ * SSR-safe: holds the source's initial value on the server.
+ *
+ * ```tsx
+ * const [query, setQuery] = createSignal("")
+ * const debounced = createDebounced(query, 300)
+ * createEffect(() => {
+ *   const q = debounced()
+ *   if (q) search(q) // fires only after a 300ms pause
+ * })
+ * ```
+ */
+export function createDebounced(source, delay) {
+    const [value, setValue] = createSignal(untrack(source));
+    if (typeof window === "undefined")
+        return value;
+    let timer;
+    createEffect(() => {
+        const next = source();
+        clearTimeout(timer);
+        timer = setTimeout(() => setValue(() => next), Math.max(0, delay));
+    });
+    onCleanup(() => clearTimeout(timer));
+    return value;
+}
+/* ------------------------------------------------------------------ */
+/* createThrottled                                                     */
+/* ------------------------------------------------------------------ */
+/**
+ * A signal that follows the source at most once per `interval` ms.
+ * The first change applies immediately (leading edge); changes inside
+ * the window collapse into one trailing update. For scroll or resize
+ * handlers that feed expensive work.
+ *
+ * SSR-safe: holds the source's initial value on the server.
+ *
+ * ```tsx
+ * const throttledY = createThrottled(scrollY, 100)
+ * ```
+ */
+export function createThrottled(source, interval) {
+    const [value, setValue] = createSignal(untrack(source));
+    if (typeof window === "undefined")
+        return value;
+    const wait = Math.max(0, interval);
+    let last = 0;
+    let timer;
+    createEffect(() => {
+        const next = source();
+        const t = Date.now();
+        clearTimeout(timer);
+        timer = undefined;
+        if (t - last >= wait) {
+            last = t;
+            setValue(() => next);
+        }
+        else {
+            timer = setTimeout(() => {
+                last = Date.now();
+                timer = undefined;
+                setValue(() => next);
+            }, wait - (t - last));
+        }
+    });
+    onCleanup(() => clearTimeout(timer));
+    return value;
+}
+/**
+ * A signal persisted to `localStorage`. Reads the stored value on
+ * creation (falling back to `initialValue` when missing or corrupt),
+ * writes through on every set, and stays in sync across tabs via the
+ * `storage` event.
+ *
+ * SSR-safe and storage-less-safe: without `window.localStorage` it
+ * behaves like a plain signal.
+ *
+ * ```tsx
+ * const theme = createLocalStorage<"light" | "dark">("theme", "light")
+ * theme.set("dark") // localStorage.theme = '"dark"'
+ * ```
+ */
+export function createLocalStorage(key, initialValue, options = {}) {
+    const { serialize = JSON.stringify, deserialize = JSON.parse, sync = true, } = options;
+    const storage = () => {
+        if (typeof window === "undefined")
+            return null;
+        try {
+            return window.localStorage;
+        }
+        catch {
+            return null; // private mode / blocked storage
+        }
+    };
+    const read = () => {
+        const store = storage();
+        if (!store)
+            return initialValue;
+        try {
+            const raw = store.getItem(key);
+            return raw === null ? initialValue : deserialize(raw);
+        }
+        catch {
+            return initialValue; // corrupt JSON: fall back, don't crash
+        }
+    };
+    const [value, setValue] = createSignal(read());
+    const set = ((next) => {
+        const resolved = typeof next === "function"
+            ? next(untrack(value))
+            : next;
+        setValue(() => resolved);
+        try {
+            storage()?.setItem(key, serialize(resolved));
+        }
+        catch {
+            // Quota exceeded or blocked: the signal still updates.
+        }
+        return resolved;
+    });
+    const remove = () => {
+        try {
+            storage()?.removeItem(key);
+        }
+        catch {
+            // ignore
+        }
+        setValue(() => initialValue);
+    };
+    if (typeof window !== "undefined" && sync) {
+        const onStorage = (event) => {
+            if (event.key !== key)
+                return;
+            try {
+                setValue(() => event.newValue === null ? initialValue : deserialize(event.newValue));
+            }
+            catch {
+                // ignore corrupt cross-tab writes
+            }
+        };
+        window.addEventListener("storage", onStorage);
+        onCleanup(() => window.removeEventListener("storage", onStorage));
+    }
+    return { value, set, remove };
+}
+/* ------------------------------------------------------------------ */
+/* createMediaQuery                                                    */
+/* ------------------------------------------------------------------ */
+/**
+ * A boolean signal tracking a CSS media query, updating live when the
+ * query starts or stops matching. The primitive behind
+ * `usePrefersReducedMotion`, generalized.
+ *
+ * SSR-safe (and safe where `matchMedia` is missing): constant `false`.
+ *
+ * ```tsx
+ * const wide = createMediaQuery("(min-width: 1024px)")
+ * const columns = () => (wide() ? 4 : 2)
+ * ```
+ */
+export function createMediaQuery(query) {
+    const no = () => false;
+    if (typeof window === "undefined" ||
+        typeof window.matchMedia !== "function") {
+        return no;
+    }
+    const mql = window.matchMedia(query);
+    const [matches, setMatches] = createSignal(mql.matches);
+    const onChange = (event) => {
+        setMatches(event.matches);
+    };
+    mql.addEventListener("change", onChange);
+    onCleanup(() => mql.removeEventListener("change", onChange));
+    return matches;
+}
+/**
+ * Call `handler` when the user interacts outside the element:
+ * dropdowns, popovers, and menus that dismiss on outside press.
+ *
+ * Listens on `window` (so it works even when the press lands on an
+ * overlaying element), ignores presses inside the ref, and cleans up
+ * on unmount. SSR-safe: no-op on the server.
+ *
+ * ```tsx
+ * let menu!: HTMLDivElement
+ * const [open, setOpen] = createSignal(false)
+ * createClickOutside(() => menu, () => setOpen(false))
+ * ```
+ */
+export function createClickOutside(ref, handler, options = {}) {
+    if (typeof window === "undefined")
+        return;
+    const { events = ["pointerdown"] } = options;
+    const onEvent = (event) => {
+        const el = ref();
+        if (!el)
+            return;
+        const target = event.target;
+        // Shadow-DOM aware: composedPath pierces shadow roots.
+        const path = typeof event.composedPath === "function" ? event.composedPath() : [];
+        const inside = (target !== null && el.contains(target)) || path.includes(el);
+        if (!inside)
+            handler(event);
+    };
+    for (const name of events) {
+        window.addEventListener(name, onEvent);
+    }
+    onCleanup(() => {
+        for (const name of events) {
+            window.removeEventListener(name, onEvent);
+        }
+    });
+}
+let lockCount = 0;
+let savedOverflow = "";
+/**
+ * Lock body scroll while overlays are open: modals, drawers, the
+ * bottom sheet. `overflow: hidden` goes on `document.body`, the
+ * previous value is restored when the last lock releases, and nested
+ * locks are reference-counted so two stacked modals cannot unlock
+ * each other early. Unmounting while locked releases the lock.
+ *
+ * SSR-safe: no-op on the server.
+ *
+ * ```tsx
+ * const scroll = createScrollLock()
+ * createEffect(() => {
+ *   if (modalOpen()) scroll.lock()
+ *   else scroll.unlock()
+ * })
+ * ```
+ */
+export function createScrollLock() {
+    const [locked, setLocked] = createSignal(false);
+    if (typeof window === "undefined" || typeof document === "undefined") {
+        return { locked, lock: () => { }, unlock: () => { } };
+    }
+    let held = 0;
+    const lock = () => {
+        if (lockCount === 0) {
+            savedOverflow = document.body.style.overflow;
+            document.body.style.overflow = "hidden";
+        }
+        lockCount++;
+        held++;
+        setLocked(true);
+    };
+    const unlock = () => {
+        if (held === 0)
+            return;
+        held--;
+        lockCount--;
+        if (lockCount === 0) {
+            document.body.style.overflow = savedOverflow;
+            setLocked(false);
+        }
+        else if (held === 0) {
+            setLocked(false);
+        }
+    };
+    onCleanup(() => {
+        while (held > 0)
+            unlock();
+    });
+    return { locked, lock, unlock };
+}
+/**
+ * Infinite scroll: observe a sentinel element at the end of a list
+ * and call `onLoadMore` as it approaches the viewport, prefetching
+ * before the user hits the bottom.
+ *
+ * Built on IntersectionObserver with a `rootMargin` prefetch zone.
+ * SSR-safe (and safe without IntersectionObserver): never fires.
+ *
+ * ```tsx
+ * let sentinel!: HTMLDivElement
+ * const [items, setItems] = createSignal<string[]>([])
+ * const [hasMore, setHasMore] = createSignal(true)
+ * createInfiniteScroll(() => sentinel, {
+ *   onLoadMore: () => loadPage(),
+ *   disabled: () => !hasMore(),
+ * })
+ * <For each={items()}>{(item) => <Row item={item} />}</For>
+ * <div ref={sentinel} />
+ * ```
+ */
+export function createInfiniteScroll(ref, options) {
+    const { onLoadMore, threshold = 200, disabled } = options;
+    if (typeof window === "undefined" ||
+        typeof IntersectionObserver === "undefined") {
+        return;
+    }
+    createEffect(() => {
+        const el = ref();
+        if (!el)
+            return;
+        if (disabled?.() === true)
+            return;
+        const observer = new IntersectionObserver((entries) => {
+            for (const entry of entries) {
+                if (entry.isIntersecting)
+                    onLoadMore();
+            }
+        }, { rootMargin: `${threshold}px` });
+        observer.observe(el);
+        onCleanup(() => observer.disconnect());
+    });
+}

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export { usePrefersReducedMotion, prefersReducedMotion, } from "./reduced-motion
 export { isLowPowerMode, useLowPowerMode, type LowPowerOptions, } from "./power.js";
 export { createSlotMachine, type SlotMachineControls, type SlotMachineOptions, type SlotMachineStatus, createRedPacket, type RedPacketCoin, type RedPacketControls, type RedPacketOptions, type RedPacketStatus, createConfetti, type ConfettiControls, type ConfettiOptions, createEmojiBurst, type EmojiBurstControls, type EmojiBurstOptions, createScratch, type ScratchControls, type ScratchOptions, } from "./fun.js";
 export { createStagger } from "./stagger.js";
+export { createDebounced, createThrottled, createLocalStorage, type LocalStorageOptions, type LocalStorageControls, createMediaQuery, createClickOutside, type ClickOutsideOptions, createScrollLock, type ScrollLockControls, createInfiniteScroll, type InfiniteScrollOptions, } from "./dom.js";
 export { createHorizontalScroll, type HorizontalScrollOptions, type HorizontalScrollResult, } from "./horizontal.js";
 export { createScrub, type ScrubKeyframe, type ScrubOptions } from "./scrub.js";
 export { createScrollColor, type ScrollColorStop, type ScrollColorOptions, type ScrollColorFormat, createScrollTracking, type ScrollTrackingOptions, createScrollLine, type ScrollLineOptions, type ScrollLineStyle, type ScrollLineAxis, type ScrollLineOrigin, } from "./scrollfx.js";

package/dist/index.js

@@ -14,6 +14,7 @@ export { usePrefersReducedMotion, prefersReducedMotion, } from "./reduced-motion
 export { isLowPowerMode, useLowPowerMode, } from "./power.js";
 export { createSlotMachine, createRedPacket, createConfetti, createEmojiBurst, createScratch, } from "./fun.js";
 export { createStagger } from "./stagger.js";
+export { createDebounced, createThrottled, createLocalStorage, createMediaQuery, createClickOutside, createScrollLock, createInfiniteScroll, } from "./dom.js";
 export { createHorizontalScroll, } from "./horizontal.js";
 export { createScrub } from "./scrub.js";
 export { createScrollColor, createScrollTracking, createScrollLine, } from "./scrollfx.js";

package/package.json

@@ -43,5 +43,5 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.21.0"
+  "version": "0.22.0"
 }