use-is-match-media

PreviousNext

A hook to check if the media query matches

Docs
hookshook

Preview

Loading preview…
registry/hooks/use-is-match-media.ts
import { useState } from 'react'
import { useIsomorphicLayoutEffect } from '@/registry/hooks/use-isomorphic-layout-effect'

export function useIsMatchMedia(mediaQueryString: string) {
  const [isMatch, setIsMatch] = useState(() => {
    if (typeof window === 'undefined') return false
    return window.matchMedia(mediaQueryString).matches
  })

  useIsomorphicLayoutEffect(() => {
    const mediaQueryList = window.matchMedia(mediaQueryString)

    setIsMatch(mediaQueryList.matches)

    const listener = (event: MediaQueryListEvent) => {
      setIsMatch(event.matches)
    }

    mediaQueryList.addEventListener('change', listener)

    return () => {
      mediaQueryList.removeEventListener('change', listener)
    }
  }, [mediaQueryString])

  return isMatch
}

Installation

npx shadcn@latest add @hooks/use-is-match-media

Usage

import { UseIsMatchMedia } from "@/hooks/use-is-match-media"
const value = UseIsMatchMedia()