Skip to content
On this page

useWindowScroll

Category
Export Size
1.1 kB
Last Changed
last year

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
Shinigami
Alex Kozack

Changelog

No recent changes

Released under the MIT License.