⬅️ Back to Table of Contents

📄 usePreferredColorScheme

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	3
🟢 Vue Composition API	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Type Aliases

🛠️ File Location:

📂 packages/core/usePreferredColorScheme/index.ts

📦 Imports

Name	Source
ConfigurableWindow	../_configurable
computed	vue
useMediaQuery	../useMediaQuery

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none

---

Functions

usePreferredColorScheme(options: ConfigurableWindow): any

Reactive prefers-color-scheme media query.

Parameters:

• options any (optional): No description

See: https://vueuse.org/usePreferredColorScheme

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive prefers-color-scheme media query.
 *
 * @see https://vueuse.org/usePreferredColorScheme
 * @param [options]
 *
 * @__NO_SIDE_EFFECTS__
 */

Calls:

• useMediaQuery (from ../useMediaQuery)
• computed (from vue)

Code

export function usePreferredColorScheme(options?: ConfigurableWindow) {
  const isLight = useMediaQuery('(prefers-color-scheme: light)', options)
  const isDark = useMediaQuery('(prefers-color-scheme: dark)', options)

  return computed<ColorSchemeType>(() => {
    if (isDark.value)
      return 'dark'
    if (isLight.value)
      return 'light'
    return 'no-preference'
  })
}

---

Type Aliases

ColorSchemeType

type ColorSchemeType = 'dark' | 'light' | 'no-preference';

---

Generated by Syntax Scribe