streamich/react-use

useWindowSize callback

Open

#915 opened on Jan 21, 2020

View on GitHub
 (7 comments) (2 reactions) (0 assignees)TypeScript (43,979 stars) (3,273 forks)batch import
enhancementgood first issuehelp wanted

Description

Add ability to trigger a callback when the size is updated.

const { ... } = useWindowSize(() => {
...callback on resize...
});

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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React hooksTypeScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the existing `useWindowSize` implementation in `src/useWindowSize.ts` or similar. The hook currently returns size and does not accept a callback. You'll need to add an optional callback parameter that fires on resize, likely using `useEffect` with a debounced or direct call. Check if there are any existing tests in `src/ tests /useWindowSize.test.ts` to understand the testing pattern. Consider whether the callback should be called with the new size dimensions.