コンテンツへスキップ

useMediaQuery

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

リアクティブなメディアクエリ。MediaQueryListオブジェクトを作成したら、クエリの結果を確認したり、結果が変更されたときに通知を受け取ることができます。

デモ

isLargeScreen: false
prefersDark: false

使用方法

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

const isLargeScreen = useMediaQuery('(min-width: 1024px)')
const isPreferredDark = useMediaQuery('(prefers-color-scheme: dark)')

型定義

TypeScript
/**
 * Reactive Media Query.
 *
 * @see https://vueuse.dokyumento.jp/useMediaQuery
 * @param query
 * @param options
 */
export declare function useMediaQuery(
  query: MaybeRefOrGetter<string>,
  options?: ConfigurableWindow,
): Ref<boolean, boolean>

ソースコード

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

コントリビューター

Anthony Fu
Antério Vieira
Anthony Fu
Indrek Ardel
Zhousg
Young
Jelf
Dominik Freier
webfansplz
Eureka
karma
Alex Kozack
Jacob Clevenger

変更ログ

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2サポートの削除、バンドルの最適化、クリーンアップ (#4349)
v10.3.0 2023/7/30
f3969 - 修正: クエリ変更時のみイベントリスナーを追加/削除します (#3236)
v10.0.0-beta.4 2023年4月13日
4d757 - 機能追加(型): MaybeComputedRefMaybeRefOrGetter に名前変更
10e98 - 機能追加(toRef): resolveReftoRef に名前変更
v10.0.0-beta.3 2023年4月12日
4e7b0 - 修正(useWindowSize): orientationchange リスナーの代わりにメディアクエリを使用します (#2919)
v9.3.0 2022年9月26日
33098 - 機能追加: クエリを ref として許可します (#2178)

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