useWindowScroll

Demo

See scroll values in the lower right corner of the screen.

Scroll value

x: 0
y: 0

Usage

import { useWindowScroll } from '@vueuse/core'

const { x, y } = useWindowScroll()
console.log(x.value) // read current x scroll value
y.value = 100 // scroll y to 100

Type Declarations

typescript

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