This commit is contained in:
eewing
2026-02-17 14:10:16 -06:00
parent 2bca5834c5
commit cf73cd3b4c
11246 changed files with 1690552 additions and 0 deletions
@@ -0,0 +1 @@
export * from "./use-intersection-observer.svelte.js";
+1
View File
@@ -0,0 +1 @@
export * from "./use-intersection-observer.svelte.js";
@@ -0,0 +1,28 @@
import type { MaybeElementGetter, MaybeGetter } from "../../internal/types.js";
import { type ConfigurableWindow } from "../../internal/configurable-globals.js";
export interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, "root">, ConfigurableWindow {
/**
* Whether to start the observer immediately upon creation. If set to `false`, the observer
* will only start observing when `resume()` is called.
*
* @defaultValue true
*/
immediate?: boolean;
/**
* The root document/element to use as the bounding box for the intersection.
*/
root?: MaybeElementGetter;
}
/**
* Watch for intersection changes of a target element.
*
* @see https://runed.dev/docs/utilities/useIntersectionObserver
* @see https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver IntersectionObserver MDN
*/
export declare function useIntersectionObserver(target: MaybeGetter<HTMLElement | HTMLElement[] | null | undefined>, callback: IntersectionObserverCallback, options?: UseIntersectionObserverOptions): {
readonly isActive: boolean;
stop: () => void;
pause(): void;
resume(): void;
};
export type UseIntersectionObserverReturn = ReturnType<typeof useIntersectionObserver>;
@@ -0,0 +1,49 @@
import { extract } from "../extract/extract.svelte.js";
import { get } from "../../internal/utils/get.js";
import { defaultWindow } from "../../internal/configurable-globals.js";
/**
* Watch for intersection changes of a target element.
*
* @see https://runed.dev/docs/utilities/useIntersectionObserver
* @see https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver IntersectionObserver MDN
*/
export function useIntersectionObserver(target, callback, options = {}) {
const { root, rootMargin = "0px", threshold = 0.1, immediate = true, window = defaultWindow, } = options;
let isActive = $state(immediate);
let observer;
const targets = $derived.by(() => {
const value = extract(target);
return new Set(value ? (Array.isArray(value) ? value : [value]) : []);
});
const stop = $effect.root(() => {
$effect(() => {
if (!targets.size || !isActive || !window)
return;
observer = new window.IntersectionObserver(callback, {
rootMargin,
root: get(root),
threshold,
});
for (const el of targets)
observer.observe(el);
return () => {
observer?.disconnect();
};
});
});
$effect(() => {
return stop;
});
return {
get isActive() {
return isActive;
},
stop,
pause() {
isActive = false;
},
resume() {
isActive = true;
},
};
}