Skip to content

Commit 2d7b34f

Browse files
authored
Merge pull request #30 from taion/update-docs
Clarify <ScrollContainer> docs
2 parents b809d3d + d875e35 commit 2d7b34f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ useScroll((prevRouterProps, { routes }) => {
6565

6666
### Scrolling elements other than `window`
6767

68-
Use `<ScrollContainer>` to manage the scroll behavior of elements other than `window`. Each `<ScrollContainer>` must be given a unique `scrollKey`, and can be given an optional `shouldUpdateScroll` callback that behaves as above.
68+
Use `<ScrollContainer>` in components rendered by a router with the `useScroll` middleware to manage the scroll behavior of elements other than `window`. Each `<ScrollContainer>` must be given a unique `scrollKey`, and can be given an optional `shouldUpdateScroll` callback that behaves as above.
6969

7070
```jsx
7171
import { ScrollContainer } from 'react-router-scroll';

0 commit comments

Comments
 (0)