From 84493a67b322d1ade2a54ad648c4961dce99dce4 Mon Sep 17 00:00:00 2001 From: Jimmy Moon Date: Wed, 7 Mar 2018 16:38:11 +0900 Subject: [PATCH] Update readme.md (#3957) Update readme for scroll props related to #3950 --- readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/readme.md b/readme.md index 5565a68c..844ee257 100644 --- a/readme.md +++ b/readme.md @@ -429,6 +429,15 @@ export default ({ href, name }) => ``` +##### Disabling the scroll changes to top on page + +The default behaviour of `` is to scroll to the top of the page. When there is a hash defined it will scroll to the specific id, just like a normal `` tag. To prevent scrolling to the top / hash `scroll={false}` can be added to ``: + +```jsx +Disables scrolling +Changes with scrolling to top +``` + #### Imperatively