Added a second parameter to setScrollTop. Fixes #149

The second parameter `force` can be set to true if no transition is desired. Skrollr will then jump straight to the new position.
Prinzhorn · Feb 24, 2013 · a82abf2 · a82abf2
1 parent 89e174e
commit a82abf2
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -422,10 +422,12 @@ var offset = s.relativeToAbsolute(document.getElementById('foo'), 'top', 'bottom
 
 Returns the current scroll offset in pixels. Normalizes different browser quirks and returns the iScroll y-position in case of skrollr.mobile.
 
-### setScrollTop(top)
+### setScrollTop(top[, force = false])
 
 Sets the top offset using `window.scrollTo(0, top)` on dektop or `iscroll.scrollTo(0, -top)` when using skrollr.mobile.
 
+When `force` is set to `true`, skrollr will jump to the new position without any kind of transition. By default the global `smoothScrolling` setting applies.
+
 ### animateTo(top[, options])
 
 Animates the scroll position from current position to `top`. Possible options are

diff --git a/dist/skrollr.min.js b/dist/skrollr.min.js
diff --git a/examples/circular_motion.html b/examples/circular_motion.html
@@ -34,7 +34,7 @@
 		render: function(data) {
 			//Loop
 			if(data.curTop === data.maxTop) {
-				this.setScrollTop(0);
+				this.setScrollTop(0, true);
 			}
 		}
 	});

diff --git a/src/skrollr.js b/src/skrollr.js
@@ -527,7 +527,13 @@
 		return !!_scrollAnimation;
 	};
 
-	Skrollr.prototype.setScrollTop = function(top) {
+	Skrollr.prototype.setScrollTop = function(top, force) {
+		//Don't do smooth scrolling (last top === new top).
+		if(force === true) {
+			_lastTop = top;
+			_forceRender = true;
+		}
+
 		//skrollr.iscroll is an instance of iscroll available in mobile mode
 		if(skrollr.iscroll) {
 			//Notice the minus.