English

useElementSize

Tags:

A React Hook that returns the size of an element.

Demo

Try to resize the textarea to see the size changes.

See API for more details.

Click links below to view source on GitHub.

const { width, height, ...useResizeObserverReturns } = useElementSize(elementTarget, defaultValue, options)

ElementTarget is a union type that represents various kinds of elements that can be targeted.

export type ElementSize = {
  /**
   * The width of the element.
   */
  width: number
  /**
   * The height of the element.
   */
  height: number
}

Options of useResizeObserver, see useResizeObserver#options for more details.

Returns of useResizeObserver, see useResizeObserver#returns for more details.

export type UseElementSizeReturns = ElementSize & UseResizeObserverReturns

ON THIS PAGE