Skip to content
On this page

useWindowScroll

响应式获取窗口的滚动位置。

Reactive window scroll

例子

查看屏幕右下角的滚动值。
See scroll values in the lower right corner of the screen.
滚动值
x: 0
y: 0

Usage

js
import { useWindowScroll } from '@vueuse/core'

const { x, y } = useWindowScroll()
import { useWindowScroll } from '@vueuse/core'

const { x, y } = useWindowScroll()

Type Declarations

typescript
/**
 * Reactive window scroll.
 *
 * @see https://vueuse.org/useWindowScroll
 * @param options
 */
export declare function useWindowScroll({ window }?: ConfigurableWindow): {
  x: Ref<number>
  y: Ref<number>
}
export type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>
/**
 * Reactive window scroll.
 *
 * @see https://vueuse.org/useWindowScroll
 * @param options
 */
export declare function useWindowScroll({ window }?: ConfigurableWindow): {
  x: Ref<number>
  y: Ref<number>
}
export type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>

Source

Category
Export Size
1.1 kB
Last Changed
last month

SourceDemoDocs

贡献者(Contributors)

日志(Changelog)

v9.13.0 on 2023/2/18
e490a - fix: use scrollX instead of pageXOffset (#2776)

Released under the MIT License.