Skip to content

Commit a62c060

Browse files
committed
chore: add migration notes
1 parent 553d075 commit a62c060

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,9 @@ difficult to attach event listeners for scrolling to an arbitrary element.
103103
| debounce | number | 200 | milliseconds, how much debounce there should be on the callback |
104104
| offset | number | 0 | offset from bottom in pixels. E.g. 300 if it should invoke `onBottom` 300px before the bottom. |
105105
| children | React.Node _or_ Function | null | Not required, but you can use this to wrap your components. Most useful when you have some conditional rendering. If this is a function, that function will receive a React.RefObject that _needs_ to be passed to a child element. This element will then be used as the scroll container. |
106+
107+
# Migrating from 2.x.x to 3.x.x
108+
109+
There are no breaking changes except that the required version of React is now 16.8.0. If you are on an
110+
older version of React you can either upgrade React, or stay on version 2.x.x. If you already
111+
are on a newer version of React you don't have to do anything, except maybe try out the new hook implementation. :)

0 commit comments

Comments
 (0)