useElementSize

Hook that observes and returns the width and height of element

elements

test coverage

Last changed: last month

Installation

Library

CLI

Manual

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

Usage

const { value } = useElementSize(ref);
// or
const { ref, value } = useElementSize();

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget	-	The target element to observe

Returns

UseElementSizeReturn

Returns

{ ref: StateRef<Target> } & UseElementSizeReturn

Type declaration

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

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

export interface UseElementSizeValue {
  /** The element's height */
  height: number;
  /** The element's width */
  width: number;
}

export interface UseElementSizeReturn {
  value: UseElementSizeValue;
}

export interface UseElementSize {
  (target: HookTarget): UseElementSizeReturn;

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

Source

Source • Demo

Contributors

D

debabin

A

Alexander Lee

B

babin

V

VLADISLAW9