useInView

This composable function is used to check if an element is currently visible in the viewport.

Usage

import { useInView } from '@flux-ui/internals';
import { useTemplateRef } from 'vue';

const element = useTemplateRef('element');

useInView(element, {
    threshold: 1
});

Type declarations

import type { TemplateRef } from '@flux-ui/internals';
import type { Ref } from 'vue';

export declare function useInView<TElement extends HTMLElement>(
    containerRef: TemplateRef<TElement>,
    options: UseInViewOptions = {}
): Ref<boolean>;

type UseInViewOptions = IntersectionObserverInit & {
    readonly initial?: boolean;
};

Used by

• Visual
  • Flickering grid