jaredLunde/react-hook

Looking for change log or why the breaking change (in window-size)?

Closed this issue · 1 comments

I see the window-size bumped to version 3 in one of my projects. I struggle to find a change log, release information or migration instructions.

Can you please elaborate what was changed that might break projects using this dependency?

@react-hook/window-size latest 2.1.1 ❯ 3.0.6 https://github.com/jaredLunde/react-hook/tree/master/packages/window-size#readme

Thanks a bunch

v2 signature:

useWindowSize(
  initialWidth?: number, 
  initialHeight?: number, 
  {['fps' | 'wait']?: number, 
  leading?: boolean}
)

v3 signature:

useWindowSize({
  initialWidth?: number, 
  initialHeight?: number, 
  ['fps' | 'wait']?: number, 
  leading?: boolean
})