VueUseuseWindowScroll
Reactive window scroll
Demo
See scroll values in the lower right corner of the screen.
Scroll value
x: 0y: 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
Contributors
Anthony Fu
Nurettin Kaya
Antério Vieira
Jelf
webfansplz
Maik Kowol
Shinigami
Alex Kozack