@react-hook/window-size

What is @react-hook/window-size?

@react-hook/window-size is a React hook that allows you to easily get the current window size and respond to window resize events. It provides a simple API to access the width and height of the window, making it useful for responsive design and dynamic layout adjustments.

What are @react-hook/window-size's main functionalities?

Get Window Size

This feature allows you to get the current width and height of the window. The `useWindowSize` hook returns an array with the width and height, which you can use to render responsive components.

import { useWindowSize } from '@react-hook/window-size';

function MyComponent() {
  const [width, height] = useWindowSize();

  return (
    <div>
      <p>Window width: {width}px</p>
      <p>Window height: {height}px</p>
    </div>
  );
}

Custom Throttle

This feature allows you to throttle the resize event updates. By passing a number to `useWindowSize`, you can control how often the window size is updated, which can improve performance by reducing the frequency of re-renders.

import { useWindowSize } from '@react-hook/window-size';

function MyComponent() {
  const [width, height] = useWindowSize(250); // Throttle updates every 250ms

  return (
    <div>
      <p>Window width: {width}px</p>
      <p>Window height: {height}px</p>
    </div>
  );
}

Other packages similar to @react-hook/window-size

react-use

react-use is a collection of essential React hooks, including a `useWindowSize` hook. It provides similar functionality to @react-hook/window-size but also includes a wide variety of other hooks for different use cases, making it a more comprehensive solution for managing state and side effects in React applications.

react-responsive

react-responsive is a package that allows you to create media query components in React. While it doesn't provide a direct hook for window size, it offers a more declarative approach to handling responsive design by allowing you to define breakpoints and render different components based on the current viewport size.

use-resize-observer

use-resize-observer is a React hook that uses the ResizeObserver API to track the size of a DOM element. While it is more focused on element size rather than window size, it can be used to achieve similar results by observing the document's root element. It provides more granular control over resizing behavior compared to @react-hook/window-size.

README

---

@react-hook/window-size

React hooks for updating components when the size of the window changes.

Installation

npm i @react-hook/window-size

yarn add @react-hook/window-size

Usage

// using debounced values
import {
  useWindowSize, 
  useWindowWidth, 
  useWindowHeight
} from '@react-hook/window-size'

const F = props => {
  const [width, height] = useWindowSize(
    360 /* initialWidth when there is no window */,
    720 /* initialHeight when there is no window */,
    {wait: 100}
  )
}

// using throttled values
import {
  useWindowSize, 
  useWindowWidth, 
  useWindowHeight
} from '@react-hook/window-size/throttled'

const F = props => {
  const [width, height] = useWindowSize(
    360 /* initialWidth when there is no window */,
    720 /* initialHeight when there is no window */,
    {fps: 30}
  )
}

Debounced

useWindowSize(initialWidth?: number, initialHeight?: number, debounceOptions?: object)

• initialWidth <number>
  • The initial width to use when there is no window object
• initialHeight <number>
  • The initial width to use when there is no window object
• debounceOptions <object>
  • wait <number>
    • default 100
    • Defines the amount of time you want setState to wait after the last received action before executing
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns [width: integer, height: integer]: array

• width
  • The current width of the window
• height
  • The current height of the window

useWindowWidth(initialWidth?: number, debounceOptions?: object)

• initialWidth <number>
  • The initial width to use when there is no window object
• debounceOptions <object>
  • wait <number>
    • default 100
    • Defines the amount of time you want setState to wait after the last received action before executing
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns width: integer

• width
  • The current width of the window

useWindowHeight(initialHeight?: number, debounceOptions?: object)

• initialHeight <number>
  • The initial height to use when there is no window object
• debounceOptions <object>
  • wait <number>
    • default 100
    • Defines the amount of time you want setState to wait after the last received action before executing
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns height: integer

• height
  • The current height of the window

---

Throttled

import { 
  useWindowSize, 
  useWindowWidth,
  useWindowHeight,
} from '@react-hook/toggle/throttled'

useWindowSize(initialWidth?: number, initialHeight?: number, throttleOptions?: object)

• initialWidth <number>
  • The initial width to use when there is no window object
• initialHeight <number>
  • The initial width to use when there is no window object
• throttleOptions <object>
  • fps <number>
    • default 30
    • Defines the rate in frames per second with which the scroll position is updated
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns [width: integer, height: integer]: array

• width
  • The current width of the window
• height
  • The current height of the window

useWindowWidth(initialWidth?: number, throttleOptions?: object)

• initialWidth <number>
  • The initial width to use when there is no window object
• throttleOptions <object>
  • fps <number>
    • default 30
    • Defines the rate in frames per second with which the scroll position is updated
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns width: integer

• width
  • The current width of the window

useWindowHeight(initialHeight?: number, throttleOptions?: object)

• initialHeight <number>
  • The initial height to use when there is no window object
• throttleOptions <object>
  • fps <number>
    • default 30
    • Defines the rate in frames per second with which the scroll position is updated
  • leading <bool>
    • default false
    • Calls setState on the leading edge (right away). When false setState will not be called until the next frame is due

Returns height: integer

• height
  • The current height of the window