⬅️ Back to Table of Contents

📄 usePreferredDark

📊 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

Reactive dark theme preference.

Parameters:

• options any (optional): No description

See: https://vueuse.org/usePreferredDark

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

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

Calls:

• useMediaQuery (from ../useMediaQuery)

Code

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

---

Generated by Syntax Scribe