1---
2category: Elements
3---
4 
5# useWindowScroll
6 
7Reactive window scroll
8 
9## Usage
10 
11```vue
12<script setup lang="ts">
13import { useWindowScroll } from '@vueuse/core'
14 
15const { x, y } = useWindowScroll()
16</script>
17 
18<template>
19  <div>
20    read current x, y scroll: {{ x }}, {{ y }}
21  </div>
22  <button @click="x = 100">
23    scroll X to 100
24  </button>
25  <button @click="y = 100">
26    scroll Y to 100
27  </button>
28</template>
29```
30 
31## Type Declarations
32 
33```ts
34export interface UseWindowScrollOptions
35  extends ConfigurableWindow, UseScrollOptions {}
36export interface UseWindowScrollReturn extends UseScrollReturn {}
37/**
38 * Reactive window scroll.
39 *
40 * @see https://vueuse.org/useWindowScroll
41 * @param options
42 */
43export declare function useWindowScroll(
44  options?: UseWindowScrollOptions,
45): UseWindowScrollReturn
46```
47