コンテンツへスキップ

usePreferredColorScheme

カテゴリ
エクスポートサイズ
570 B
最終更新日
先週

リアクティブな prefers-color-scheme メディアクエリ。

デモ

優先カラーテーマ
no-preference

使用方法

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

const preferredColor = usePreferredColorScheme()

コンポーネントの使用例

この関数は、`@vueuse/components` パッケージを介して、レンダーレスコンポーネントバージョンも提供します。使用方法の詳細はこちら

Vue
<template>
  <UsePreferredColorScheme v-slot="{ colorScheme }">
    Preferred Color Scheme: {{ colorScheme }}
  </UsePreferredColorScheme>
</template>

型定義

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

ソースコード

ソースコードデモドキュメント

コントリビューター

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

変更ログ

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2サポートの削除、バンドルの最適化、クリーンアップ (#4349)
v9.11.0 2023/1/17
d5321 - fix(components): defineComponent をピュアとしてマーク (#2623)

MITライセンスの下でリリースされています。