Skip to content
On this page

useWindowScroll

Category
Export Size
1.1 kB
Last Changed
4 days ago

Reactive window scroll

Demo

See scroll values in the lower right corner of the screen.
Scroll value
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 declare 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 declare type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>

Source

SourceDemoDocs

Contributors

Anthony Fu
Nurettin Kaya
Antério Vieira
Maik Kowol
Shinigami
Alex Kozack

Changelog

v9.7.0 on 12/16/2022
5df0a - fix: use configured window onScroll (#2545)

Released under the MIT License.