Skip to content
aq-ui
Back to HooksHook

Use Media Query

Open-code aq-ui React hook for Use Media Query.

Installation

pnpm dlx aq-ui@alpha add use-media-query

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useMediaQuery } from "@/hooks/use-media-query"

useMediaQuery

functionSource L65

Open-code aq-ui React hook for Use Media Query.

function useMediaQuery(query: string, { defaultValue = false }: UseMediaQueryOptions = {}): boolean
Returns
boolean

Parameters

NameTypeDefault
querystring—
options?UseMediaQueryOptions{}

UseMediaQueryOptions

interfaceSource L61

Type contract for UseMediaQueryOptions.

interface UseMediaQueryOptions

Members

NameTypeDefault
defaultValue?booleanfalse

Files

  • hooks/use-media-query.ts

Source