streamich/react-use

[useMeasure] Ability to track a custom Ref

Open

#1227 opened on May 18, 2020

View on GitHub
 (15 comments) (19 reactions) (0 assignees)TypeScript (43,979 stars) (3,273 forks)batch import
good first issuehelp wanted

Description

Is your feature request related to a problem? Please describe.

Currently useMeasure returns a ref which needs to be assigned a ref in the JSX. This has 2 issues:

  1. The ref is not a real useRef for eg. Does not have ref.current as a prop.
  2. If I already have a component where I have a ref, I just want to track its size changes.

Describe the solution you'd like

An API of this shape: const {width, height ... } = useMeasure({ref: currentRef});

Describe alternatives you've considered

I am using https://github.com/ZeeCoder/use-resize-observer ... in the absence of the above which I want to remove.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of React refsknowledge of useMeasure hook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the current useMeasure implementation in react use (src/useMeasure.ts). The issue requests adding an optional `ref` parameter to the hook, allowing users to pass their own ref for observation. Research how the hook currently creates and returns a ref, and consider modifying it to use a provided ref if given. Ensure cleanup removes the ResizeObserver listener when the ref changes or component unmounts. Look at the comments for any proposed API or concerns. No linked PRs or assignees.