Skip to content

Commit

Permalink
Merge pull request #30 from taion/update-docs
Browse files Browse the repository at this point in the history
Clarify <ScrollContainer> docs
  • Loading branch information
taion authored Aug 6, 2016
2 parents b809d3d + d875e35 commit 2d7b34f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ useScroll((prevRouterProps, { routes }) => {

### Scrolling elements other than `window`

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.
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.

```jsx
import { ScrollContainer } from 'react-router-scroll';
Expand Down

0 comments on commit 2d7b34f

Please sign in to comment.