fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
2.6 KiB
2.6 KiB
category
| category |
|---|
| Elements |
useIntersectionObserver
Detects that a target element's visibility.
Usage
<script setup lang="ts">
import { useIntersectionObserver } from '@vueuse/core';
import { shallowRef, useTemplateRef } from 'vue';
const target = useTemplateRef('target');
const targetIsVisible = shallowRef(false);
const { stop } = useIntersectionObserver(target, ([entry], observerElement) => {
targetIsVisible.value = entry?.isIntersecting || false;
});
</script>
<template>
<div ref="target">
<h1>Hello world</h1>
</div>
</template>
Directive Usage
<script setup lang="ts">
import { vIntersectionObserver } from '@vueuse/components';
import { shallowRef, useTemplateRef } from 'vue';
const root = useTemplateRef('root');
const isVisible = shallowRef(false);
function onIntersectionObserver([entry]: IntersectionObserverEntry[]) {
isVisible.value = entry?.isIntersecting || false;
}
</script>
<template>
<div>
<p>Scroll me down!</p>
<div v-intersection-observer="onIntersectionObserver">
<p>Hello world!</p>
</div>
</div>
<!-- with options -->
<div ref="root">
<p>Scroll me down!</p>
<div v-intersection-observer="[onIntersectionObserver, { root }]">
<p>Hello world!</p>
</div>
</div>
</template>
Type Declarations
export interface UseIntersectionObserverOptions extends ConfigurableWindow {
/**
* Start the IntersectionObserver immediately on creation
*
* @default true
*/
immediate?: boolean;
/**
* The Element or Document whose bounds are used as the bounding box when testing for intersection.
*/
root?: MaybeComputedElementRef | Document;
/**
* A string which specifies a set of offsets to add to the root's bounding_box when calculating intersections.
*/
rootMargin?: string;
/**
* Either a single number or an array of numbers between 0.0 and 1.
* @default 0
*/
threshold?: number | number[];
}
export interface UseIntersectionObserverReturn extends Pausable {
isSupported: ComputedRef<boolean>;
stop: () => void;
}
/**
* Detects that a target element's visibility.
*
* @see https://vueuse.org/useIntersectionObserver
* @param target
* @param callback
* @param options
*/
export declare function useIntersectionObserver(
target: MaybeComputedElementRef | MaybeRefOrGetter<MaybeElement[]> | MaybeComputedElementRef[],
callback: IntersectionObserverCallback,
options?: UseIntersectionObserverOptions,
): UseIntersectionObserverReturn;