usePreferredDark

Category

Browser

Export Size

1.21 kB

Last Changed

2 months ago

Related

useColorModeuseDark

Reactive dark theme preference.

Demo

sourceplayground (beta)

Prefers Dark:

false

Usage

import { usePreferredDark } from '@vueuse/core'

const isDark = usePreferredDark()

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

<template>
  <UsePreferredDark v-slot="{ prefersDark }">
    Prefers Dark: {{ prefersDark }}
  </UsePreferredDark>
</template>

Type Declarations

/**
 * Reactive dark theme preference.
 *
 * @see https://vueuse.org/usePreferredDark
 * @param [options]
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function usePreferredDark(
  options?: ConfigurableWindow,
): ComputedRef<boolean>

Source

Source • Demo • Docs

Contributors

Anthony Fu

SerKo

IlyaL

Anthony Fu

vaakian X

wheat

Alex Kozack

Antério Vieira

Changelog

v14.0.0-alpha.0 on 9/1/2025

8c521 - feat(components)!: refactor components and make them consistent (#4912)

v13.6.0 on 7/28/2025

d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)