useElementVisibility ​

Tracks the visibility of an element within the viewport.

Demo ​

Usage ​

<script setup>
import { ref } from 'vue'
import { useElementVisibility } from '@vueuse/core'
const target = ref(null)
const targetIsVisible = useElementVisibility(target)
</script>
<template>
  <div ref="target">
    <h1>Hello world</h1>
  </div>
</template>

Component Usage ​

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage .

<template>
  <UseElementVisibility v-slot="{ isVisible }">
    Is Visible: {{ isVisible }}
  </UseElementVisibility>
</template>

Directive Usage ​

This function also provides a directive version via the @vueuse/components package. Learn more about the usage .

<script setup>
import { ref } from 'vue'
import { vElementVisibility } from '@vueuse/components'
const target = ref(null)
const isVisible = ref(false)
function onElementVisibility(state) {
  isVisible.value = state
</script>
<template>
  <div v-element-visibility="onElementVisibility">
    {{ isVisible ? 'inside' : 'outside' }}
  </div>
  <!-- with options -->
  <div ref="target">
    <div v-element-visibility="[onElementVisibility, { scrollTarget: target }]">
      {{ isVisible ? 'inside' : 'outside' }}
    </div>
  </div>
</template>

Type Declarations ​

export interface UseElementVisibilityOptions extends ConfigurableWindow {
  scrollTarget?: MaybeRefOrGetter<HTMLElement | undefined | null>
 * Tracks the visibility of an element within the viewport.
 * @see https://vueuse.org/useElementVisibility
export declare function useElementVisibility(
  element: MaybeComputedElementRef,