⬅️ Back to Table of Contents

📄 useWindowScroll

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	5
📐 Interfaces	2

📚 Table of Contents

• Imports
• Functions
• Interfaces

🛠️ File Location:

📂 packages/core/useWindowScroll/index.ts

📦 Imports

Name	Source
ConfigurableWindow	../_configurable
UseScrollOptions	../useScroll
UseScrollReturn	../useScroll
defaultWindow	../_configurable
useScroll	../useScroll

---

Functions

useWindowScroll(options: UseWindowScrollOptions): UseWindowScrollReturn

Reactive window scroll.

Parameters:

• options any: No description

See: https://vueuse.org/useWindowScroll

Raw JSDoc

/**
 * Reactive window scroll.
 *
 * @see https://vueuse.org/useWindowScroll
 * @param options
 */

Calls:

• useScroll (from ../useScroll)

Code

export function useWindowScroll(options: UseWindowScrollOptions = {}): UseWindowScrollReturn {
  const { window = defaultWindow, ...rest } = options
  return useScroll(window, rest)
}

---

Interfaces

UseWindowScrollOptions

Interface Code

export interface UseWindowScrollOptions extends ConfigurableWindow, UseScrollOptions {
}

UseWindowScrollReturn

Interface Code

export interface UseWindowScrollReturn extends UseScrollReturn {
}

---

Generated by Syntax Scribe