@blossom-carousel/svelte/dist/vendor/navigation/cache.d.ts

A native-scroll-first carousel component for Svelte.

import type { SnapTarget, SnapPoint } from "./snap.js";
/**
 * Per-scroller cache of computed snap geometry. Snap positions only change on
 * resize/layout shifts, never on scroll, so the host (e.g. a framework
 * composable) computes them once on init/resize/mutation and stores them here.
 * The command/paging logic then reads the cache instead of forcing layout on
 * every click. When a scroller has no cache — plain usage without a host — the
 * consumers fall back to computing live, so the cache is a pure optimization.
 */
export interface SnapCache {
    /**
     * Marker target elements, in `getMarkerTargets` (tree) order. Cached so the
     * per-frame navigation-state read skips the `querySelectorAll` on the
     * scroll hot loop; refreshed on mutation, so it tracks the live DOM.
     */
    targets: HTMLElement[];
    /**
     * Snap target per marker, in `getMarkerTargets` (tree) order. Used by the
     * `goto` command to `scrollIntoView` the target with its own inline align.
     */
    markers: SnapTarget[];
    /**
     * Sorted, de-duplicated snap points used by prev/next paging to find the
     * adjacent target and bring it into view with its own inline alignment.
     */
    pages: SnapPoint[];
    /**
     * Redistributed activation position per marker, in tree order. Scroll-
     * invariant, so the active-index selection reads only `scrollLeft` per frame
     * instead of forcing layout.
     */
    activePositions: number[];
    /**
     * `activePositions` sorted ascending. Also scroll-invariant; precomputed so
     * the per-frame active-index selection is allocation- and sort-free.
     */
    sortedActivePositions: number[];
    /**
     * Whether the scroller's inline axis is right-to-left. Resolved once per
     * refresh so the hot loop avoids a `getComputedStyle` per frame.
     */
    rtl: boolean;
}
/** Stores the computed snap geometry for a scroller. */
export declare function setSnapCache(scroller: HTMLElement, cache: SnapCache): void;
/** Reads the cached snap geometry for a scroller, or `undefined` when unset. */
export declare function getSnapCache(scroller: HTMLElement): SnapCache | undefined;
/** Drops the cached snap geometry for a scroller. */
export declare function clearSnapCache(scroller: HTMLElement): void;