usePreferredDark

Category

Browser

Export Size

1.21 kB

Last Changed

4 days 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

NoiseFan

Changelog

No recent changes