useElementVisibility

分类

元素

导出大小

793 B

上次更改

2 个月前

跟踪元素在视口中的可见性。

演示

源代码演练场 (beta)

右下角的信息

目标元素 (向下滚动)

元素在视口外部

用法

vue

<script setup lang="ts">
import { useElementVisibility
 } from '@vueuse/core'
import { useTemplateRef
 } from 'vue'

const target
 = useTemplateRef
<HTMLDivElement>('target')
const targetIsVisible
 = useElementVisibility
(target
)
</script>

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

rootMargin

如果你希望在元素完全可见之前更早地触发回调，你可以使用 rootMargin 选项 (参见 MDN IntersectionObserver/rootMargin)。

const targetIsVisible
 = useElementVisibility
(target, {
  rootMargin
: '0px 0px 100px 0px',
})

threshold

如果你想控制更新值所需的可见性百分比，你可以使用 threshold 选项 (参见 MDN IntersectionObserver/threshold)。

const targetIsVisible
 = useElementVisibility(target, {
  threshold
: 1.0, // 100% visible
})

组件用法

此函数还通过 @vueuse/components 包提供了一个无渲染组件版本。了解更多用法。

vue

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

指令用法

此函数还通过 @vueuse/components 包提供了一个指令版本。了解更多用法。

vue

<script setup lang="ts">
import { vElementVisibility
 } from '@vueuse/components'
import { shallowRef
, useTemplateRef
 } from 'vue'

const target
 = useTemplateRef
<HTMLDivElement>('target')
const isVisible
 = shallowRef
(false)

function onElementVisibility
(state
) {
  isVisible
.value
 = state

}
</script>

<template>
  <div
 v-element-visibili
ty="onElementVisibility
">
    {{ isVisible
 ? 'inside' : 'outside' }}
  </div
>

  <!-- with options -->
  <div
 ref
="target
">
    <div
 v-element-visibili
ty="[
onElementVisibility
, { 
scrollTarget
: 
target
 }]
">
      {{ isVisible
 ? 'inside' : 'outside' }}
    </div
>
  </div
>
</template>

类型声明

export interface UseElementVisibilityOptions
  extends ConfigurableWindow,
    Pick
<UseIntersectionObserverOptions
, "threshold"> {
  /**
   * @see https://mdn.org.cn/en-US/docs/Web/API/IntersectionObserver/rootMargin
   */
  rootMargin
?: MaybeRefOrGetter
<string>
  /**
   * The element that is used as the viewport for checking visibility of the target.
   */
  scrollTarget
?: MaybeRefOrGetter
<HTMLElement | undefined | null>
  /**
   * Stop tracking when element visibility changes for the first time
   *
   * @default false
   */
  once
?: boolean
}
/**
 * Tracks the visibility of an element within the viewport.
 *
 * @see https://vueuse.org.cn/useElementVisibility
 */
export declare function useElementVisibility
(
  element
: MaybeComputedElementRef
,
  options
?: UseElementVisibilityOptions,
): ShallowRef
<boolean, boolean>
export type UseElementVisibilityReturn
 = ReturnType
<typeof useElementVisibility
>