useElementVisibility

カテゴリー

要素

エクスポートサイズ

692 B

最終更新

先週

ビューポート内の要素の可視性を追跡します。

デモ

ソース

右下隅の情報

ターゲット要素 (下にスクロールしてください)

ビューポート外の要素

使い方

vue

<script setup>
import { useElementVisibility } from '@vueuse/core'
import { ref } from 'vue'

const target = ref(null)
const targetIsVisible = useElementVisibility(target)
</script>

<template>
  <div ref="target">
    <h1>Hello world</h1>
  </div>
</template>

コンポーネントの使用法

この関数は、@vueuse/componentsパッケージを介してレンダーレスコンポーネントバージョンも提供します。使用法の詳細はこちらをご覧ください。

vue

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

ディレクティブの使用法

この関数は、@vueuse/componentsパッケージを介してディレクティブバージョンも提供します。使用法の詳細はこちらをご覧ください。

vue

<script setup>
import { vElementVisibility } from '@vueuse/components'
import { ref } from 'vue'

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>

型宣言

typescript

export interface UseElementVisibilityOptions
  extends ConfigurableWindow,
    Pick<UseIntersectionObserverOptions, "threshold"> {
  scrollTarget?: MaybeRefOrGetter<HTMLElement | undefined | null>
}
/**
 * Tracks the visibility of an element within the viewport.
 *
 * @see https://vueuse.dokyumento.jp/useElementVisibility
 */
export declare function useElementVisibility(
  element: MaybeComputedElementRef,
  options?: UseElementVisibilityOptions,
): Ref<boolean, boolean>