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.org.cn/useElementVisibility
 */
export declare function useElementVisibility(
  element: MaybeComputedElementRef,
  options?: UseElementVisibilityOptions,
): Ref<boolean, boolean>