⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	2

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/core/usePreferredDark/index.ts

📦 Imports

Name	Source
ConfigurableWindow	../_configurable
useMediaQuery	../useMediaQuery

---

Functions

usePreferredDark(options: ConfigurableWindow): any

Code

export function usePreferredDark(options?: ConfigurableWindow) {
  return useMediaQuery('(prefers-color-scheme: dark)', options)
}

• JSDoc:

  /**
   * Reactive dark theme preference.
   *
   * @see https://vueuse.org/usePreferredDark
   * @param [options]
   */
  

• Parameters:

• options: ConfigurableWindow
• Return Type: any
• Calls:
• useMediaQuery (from ../useMediaQuery)

---