Skip to content
aq-ui
Back to HooksHook

Use Window Size

Open-code aq-ui React hook for Use Window Size.

Installation

pnpm dlx aq-ui@alpha add use-window-size

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 { useWindowSize } from "@/hooks/use-window-size"

const result = useWindowSize()

useWindowSize

functionSource L51

Open-code aq-ui React hook for Use Window Size.

function useWindowSize(defaultValue: WindowSize = serverWindowSize): WindowSize
Returns
WindowSize

Parameters

NameTypeDefault
defaultValue?WindowSizeserverWindowSize
const result = useWindowSize()

WindowSize

interfaceSource L5

Type contract for WindowSize.

interface WindowSize

Members

NameType
widthnumber
heightnumber

Files

  • hooks/use-window-size.ts

Source