useMediaQuery

分类

浏览器

导出大小

1.17 kB

上次更改

8 个月前

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

演示

源代码在线演练 (beta)

isLargeScreen: false
prefersDark: false

用法

import { useMediaQuery
 } from '@vueuse/core'

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

服务端渲染 (SSR) 和 Nuxt

如果你在启用了 SSR 的情况下使用 useMediaQuery，那么你需要指定在服务器和水合前要渲染的屏幕尺寸，以避免水合不匹配。

import { 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.cn/useMediaQuery
 * @param query
 * @param options
 */
export declare function useMediaQuery
(
  query
: MaybeRefOrGetter
<string>,
  options
?: ConfigurableWindow
 & {
    ssrWidth
?: number
  },
): ComputedRef
<boolean>