Skip to content

usePreferredColorScheme

Category
Export Size
515 B
Last Changed
4 months ago

响应式的 prefers-color-scheme 媒体查询。

Demo

首选配色方案:
no-preference

用法

js
import { usePreferredColorScheme } from '@vueuse/core'

const preferredColor = usePreferredColorScheme()

组件使用

vue
<template>
  <UsePreferredColorScheme v-slot="{ colorScheme }">
    首选色彩方案: {{ colorScheme }}
  </UsePreferredColorScheme>
</template>

Type Declarations

typescript
export type ColorSchemeType = "dark" | "light" | "no-preference"
/**
 * Reactive prefers-color-scheme media query.
 *
 * @see https://vueuse.org/usePreferredColorScheme
 * @param [options]
 */
export declare function usePreferredColorScheme(
  options?: ConfigurableWindow,
): ComputedRef<ColorSchemeType>

Source

SourceDemoDocs

Contributors

Anthony Fu
丶远方
Anthony Fu
vaakian X
wheat
Alex Kozack
Le Minh Tri
Antério Vieira

Changelog

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

Released under the MIT License.