useMediaQuery

    API

    import useMediaQuery from '@restart/hooks/useMediaQuery'
    • useMediaQuery(query: string | null) => boolean

      Match a media query and get updates as the match changes. The media string is passed directly to window.matchMedia and run as a Layout Effect, so initial matches are returned before the browser has a chance to paint.

      function Page() {
      const isWide = useMediaQuery('min-width: 1000px')
      return isWide ? "very wide" : 'not so wide'
      }

      Media query lists are also reused globally, hook calls for the same query will only create a matcher once under the hood.

      Parameters

      • querystring | null

        A media query

      Return Value boolean