Merge pull request fisshy#78 from GabrielCTroia/improveScrollToElm

scroller.scrollTo() can take no props now. Improve readme
EverFi · Apr 26, 2016 · f619f9c · f619f9c
2 parents 59439fb + b8e03c2
commit f619f9c
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -160,7 +160,7 @@ scroll.scrollToBottom(options);
 
 ```
 
-> Scroll To (px)
+> Scroll To (position)
 
 ```js
 
@@ -171,6 +171,27 @@ scroll.scrollTo(100, options);
 
 ```
 
+> Scroll To (Element)
+
+animateScroll.scrollTo(positionInPixels, props = {});
+
+```js
+
+var Scroll = require('react-scroll');
+var Element = Scroll.Element;
+var scroller = Scroll.scroller;
+
+<Element name="myScrollToElement"></Element>
+
+// Somewhere else, even another file
+scroller.scrollTo('myScrollToElement', {
+  duration: 1500,
+  delay: 100,
+  smooth: true,
+})
+
+```
+
 > Scroll More (px)
 
 ```js

diff --git a/modules/mixins/scroller.js b/modules/mixins/scroller.js
@@ -42,6 +42,8 @@ module.exports = {
         throw new Error("target Element not found");
       }
 
+      props = props || {};
+
       var coordinates = target.getBoundingClientRect();
 
       if(events.registered['begin']) {