⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	4
📐 Interfaces	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/core/useWindowScroll/index.ts

📦 Imports

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

---

Functions

useWindowScroll(options: UseWindowScrollOptions): { x: any; y: any; isScrolling: any; arrivedState: any; directions: any; measure(): void; }

Code

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

• JSDoc:

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

• Parameters:

• options: UseWindowScrollOptions
• Return Type: { x: any; y: any; isScrolling: any; arrivedState: any; directions: any; measure(): void; }
• Calls:
• useScroll (from ../useScroll)

---

Interfaces

UseWindowScrollOptions

Interface Code

export interface UseWindowScrollOptions extends ConfigurableWindow, UseScrollOptions {
}

---

Type Aliases

UseWindowScrollReturn

type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>;

---