Lzh on GitHub

响应式媒体查询 (Media Query)。一旦你创建了 MediaQueryList 对象,你就可以检查查询结果,或者在结果改变时接收通知。

Demo

使用

import { useMediaQuery } from '@vueuse/core'

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

服务端渲染 (SSR) 和 Nuxt

如果你在启用了 SSR 的情况下使用 useMediaQuery,那么你需要指定希望在服务器端渲染和注水 (hydration) 前使用的屏幕尺寸,以避免出现注水不匹配的问题。

import { breakpointsTailwind, useMediaQuery } from '@vueuse/core'

const isLarge = useMediaQuery(
  '(min-width: 1024px)',
  { ssrWidth: 768 } // Will enable SSR mode and render like if the screen was 768px wide
)

console.log(isLarge.value) // always false because ssrWidth of 768px is smaller than 1024px
onMounted(() => {
  console.log(isLarge.value) // false if screen is smaller than 1024px, true if larger than 1024px
})

或者,你可以使用 provideSSRWidth 在你的应用中全局设置此项。

类型声明

/**
 * Reactive Media Query.
 *
 * @see https://vueuse.org/useMediaQuery
 * @param query
 * @param options
 */
export declare function useMediaQuery(
  query: MaybeRefOrGetter<string>,
  options?: ConfigurableWindow & {
    ssrWidth?: number
  },
): ComputedRef<boolean>