Logo for jsDocs.io

react-resize-detector

  • Version 10.0.1
  • Published
  • 41.3 kB
  • 1 dependency
  • MIT license

Install

npm i react-resize-detector
yarn add react-resize-detector
pnpm add react-resize-detector

Overview

React resize detector

Index

Functions

Interfaces

Functions

function useResizeDetector

useResizeDetector: <T extends HTMLElement = any>({
    skipOnMount,
    refreshMode,
    refreshRate,
    refreshOptions,
    handleWidth,
    handleHeight,
    targetRef,
    observerOptions,
    onResize,
}?: useResizeDetectorProps<T>) => UseResizeDetectorReturn<T>;

    Interfaces

    interface useResizeDetectorProps

    interface useResizeDetectorProps<T extends HTMLElement> extends Props {}

      property targetRef

      targetRef?: MutableRefObject<T | null>;

        interface UseResizeDetectorReturn

        interface UseResizeDetectorReturn<T> extends ReactResizeDetectorDimensions {}

          property ref

          ref: OnRefChangeType<T>;

            Package Files (3)

            Dependencies (1)

            Dev Dependencies (17)

            Peer Dependencies (2)

            Badge

            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-resize-detector.

            • Markdown
              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-resize-detector)
            • HTML
              <a href="https://www.jsdocs.io/package/react-resize-detector"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>