chore: consolidate new foundation and archive v1 (#1495)

2026-09-07 12:32:57 -05:00
parent 9a5fbdbda7 5d27700026
commit 127a54fdff
3511 changed files with 727899 additions and 10 deletions
@@ -0,0 +1,54 @@
+---
+category: Elements
+---
+
+# useWindowScroll
+
+Reactive window scroll
+
+## Usage
+
+```vue
+<script setup lang="ts">
+import { useWindowScroll } from '@vueuse/core';
+
+const { x, y } = useWindowScroll();
+</script>
+
+<template>
+  <div>read current x, y scroll: {{ x }}, {{ y }}</div>
+  <button @click="x = 100">scroll X to 100</button>
+  <button @click="y = 100">scroll Y to 100</button>
+</template>
+```
+
+## Type Declarations
+
+```ts
+export interface UseWindowScrollOptions extends ConfigurableWindow, UseScrollOptions {}
+/**
+ * Reactive window scroll.
+ *
+ * @see https://vueuse.org/useWindowScroll
+ * @param options
+ */
+export declare function useWindowScroll(options?: UseWindowScrollOptions): {
+  x: WritableComputedRef<number, number>;
+  y: WritableComputedRef<number, number>;
+  isScrolling: ShallowRef<boolean, boolean>;
+  arrivedState: {
+    left: boolean;
+    right: boolean;
+    top: boolean;
+    bottom: boolean;
+  };
+  directions: {
+    left: boolean;
+    right: boolean;
+    top: boolean;
+    bottom: boolean;
+  };
+  measure(): void;
+};
+export type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>;
+```