useWindowSize

Hook that manages a window size

elements

test coverage

Last changed: last month

Installation

Library

CLI

Manual

import { useWindowSize } from '@siberiacancode/reactuse';

Usage

const { width, height } = useWindowSize();

Demo

source

Api

Parameters

Name	Type	Default	Note
params.initialWidth?	number	Number.POSITIVE_INFINITY	The initial window width
params.initialHeight?	number	Number.POSITIVE_INFINITY	The initial window height

Returns

UseWindowSizeReturn

Type declaration

interface UseWindowSizeParams {
  /** Whether to include the scrollbar in the window size calculation */
  includeScrollbar?: boolean;
}

export interface UseWindowSizeReturn {
  /** The current window height */
  height: number;
  /** The current window width */
  width: number;
}

Source

Source • Demo

Contributors

D

debabin

H

hywax