stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/usePreferredDark.md

category

category
Browser

usePreferredDark

Reactive dark theme preference.

Usage

import { usePreferredDark } from '@vueuse/core';

const isDark = usePreferredDark();

Component 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>;