Merge branch 'updated-URL'

Author: Chris Ferdinandi

README.md

@@ -5,6 +5,8 @@ A simple script to animate scrolling to anchor links. Easing support contributed
 Getting started with Smooth Scroll is really easy. [View the online tutorial](http://cferdinandi.github.com/smooth-scroll/) or dig through the `index.html` file.
 
 ## Changelog
+* v2.10 (December 31, 2013)
+  * [Added URL history support.](https://github.com/cferdinandi/smooth-scroll/pull/17)
 * v2.9 (December 9, 2013)
   * [Added fixed for infinite loop when scrolling up.](https://github.com/cferdinandi/smooth-scroll/issues/13)
 * v2.8 (December 3, 2013)

index.html

@@ -60,7 +60,7 @@ <h1 style="text-align: center; font-size: 3em;">Smooth Scroll</h1>
 			.<br>.<br>.<br>.<br>.<br>.<br>.<br>.<br>.<br>.<br>.<br>.<br>.
 		</p>
 
-		<p><a class="scroll" data-speed="400" data-easing="easeOutQuad" href="#top">Back to the top</a></p>
+		<p><a class="scroll" data-speed="400" data-easing="easeOutQuad" data-url="false" href="#top">Back to the top</a></p>
 
 	</section>
 

smooth-scroll.js

@@ -1,6 +1,6 @@
 /* =============================================================
 
-	Smooth Scroll 2.9
+	Smooth Scroll 2.10
 	Animate scrolling to anchor links, by Chris Ferdinandi.
 	http://gomakethings.com
 
@@ -10,6 +10,9 @@
 	Easing functions forked from Gaëtan Renaudeau.
 	https://gist.github.com/gre/1650294
 
+	URL history support contributed by Robert Pate.
+	https://github.com/robertpateii
+
 	Free to use under the MIT License.
 	http://gomakethings.com/mit/
 
@@ -23,7 +26,7 @@
 	if ( 'querySelector' in document && 'addEventListener' in window && Array.prototype.forEach ) {
 
 		// Function to animate the scroll
-		var smoothScroll = function (anchor, duration, easing) {
+		var smoothScroll = function (anchor, duration, easing, url) {
 
 			// Functions to control easing
 			var easingPattern = function (type, time) {
@@ -42,6 +45,13 @@
 				return time; // no easing, no acceleration
 			};
 
+			// Function to update URL
+			var updateURL = function (url, anchor) {
+				if ( url === 'true' && history.pushState ) {
+					history.pushState(null, null, '#' + anchor.id);
+				}
+			};
+
 			// Calculate how far and how fast to scroll
 			// http://www.quirksmode.org/blog/archives/2008/01/using_the_assig.html
 			var startLocation = window.pageYOffset;
@@ -77,6 +87,7 @@
 					var travelled = window.pageYOffset;
 					if ( (travelled >= (endLocation(anchor) - increments)) || ((window.innerHeight + travelled) >= document.body.offsetHeight) ) {
 						clearInterval(runAnimation);
+						updateURL(url, anchor);
 					}
 				};
 			} else { // If scrolling up
@@ -85,6 +96,7 @@
 					var travelled = window.pageYOffset;
 					if ( travelled <= endLocation(anchor) || travelled <= 0 ) {
 						clearInterval(runAnimation);
+						updateURL(url, anchor);
 					}
 				};
 			}
@@ -108,12 +120,13 @@
 				var dataID = toggle.getAttribute('href');
 				var dataTarget = document.querySelector(dataID);
 				var dataSpeed = toggle.getAttribute('data-speed');
-				var dataEasing = toggle.getAttribute('data-easing'); // WL: Added easing attribute support.
+				var dataEasing = toggle.getAttribute('data-easing');
+				var dataURL = toggle.getAttribute('data-url');
 
 				// If the anchor exists
 				if (dataTarget) {
 					// Scroll to the anchor
-					smoothScroll(dataTarget, dataSpeed || 500, dataEasing || 'easeInOutCubic');
+					smoothScroll(dataTarget, dataSpeed || 500, dataEasing || 'easeInOutCubic', dataURL || 'true');
 				}
 
 			}, false);