useMeasure

Hook to measure the size and position of an element

browser

test coverage

Last changed: last month

Installation

Library

CLI

Manual

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

Usage

const { x, y, width, height, top, left, bottom, right } = useMeasure(ref);
// or
const { ref, x, y, width, height, top, left, bottom, right } = useMeasure();

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget	-	The element to measure

Returns

UseMeasureReturn

Returns

UseMeasureReturn & { ref: StateRef<Target> }

Type declaration

import type { HookTarget } from '@/utils/helpers';

import type { StateRef } from '../useRefState/useRefState';

export type UseMeasureReturn = Pick<
  DOMRectReadOnly,
  'bottom' | 'height' | 'left' | 'right' | 'top' | 'width' | 'x' | 'y'
>;

export interface UseMeasure {
  (target: HookTarget): UseMeasureReturn;

  <Target extends Element>(
    target?: never
  ): UseMeasureReturn & {
    ref: StateRef<Target>;
  };
}

Source

Source • Demo

Contributors

D

debabin