Merge pull request cferdinandi#436 from cferdinandi/development

Added clipped scrolling support

Author: cferdinandi

README.md

@@ -127,6 +127,7 @@ var scroll = new SmoothScroll('a[href*="#"]', {
 
 	// Speed & Easing
 	speed: 500, // Integer. How fast to complete the scroll in milliseconds
+	clip: true, // If true, adjust scroll distance to prevent abrupt stops near the bottom of the page
 	offset: function (anchor, toggle) {
 
 		// Integer or Function returning an integer. How far to offset the scrolling anchor location in pixels

dist/smooth-scroll.js

@@ -1,5 +1,5 @@
 /*!
- * smooth-scroll v14.1.1: Animate scrolling to anchor links
+ * smooth-scroll v14.2.0: Animate scrolling to anchor links
  * (c) 2018 Chris Ferdinandi
  * MIT License
  * http://github.com/cferdinandi/smooth-scroll
@@ -31,6 +31,7 @@
 
 		// Speed & Easing
 		speed: 500,
+		clip: true,
 		offset: 0,
 		easing: 'easeInOutCubic',
 		customEasing: null,
@@ -254,12 +255,14 @@
 
 	/**
 	 * Calculate how far to scroll
-	 * @param {Element} anchor The anchor element to scroll to
-	 * @param {Number} headerHeight Height of a fixed header, if any
-	 * @param {Number} offset Number of pixels by which to offset scroll
+	 * Clip support added by robjtede - https://github.com/cferdinandi/smooth-scroll/issues/405
+	 * @param {Element} anchor       The anchor element to scroll to
+	 * @param {Number}  headerHeight Height of a fixed header, if any
+	 * @param {Number}  offset       Number of pixels by which to offset scroll
+	 * @param {Boolean} clip         If true, adjust scroll distance to prevent abrupt stops near the bottom of the page
 	 * @returns {Number}
 	 */
-	var getEndLocation = function (anchor, headerHeight, offset) {
+	var getEndLocation = function (anchor, headerHeight, offset, clip) {
 		var location = 0;
 		if (anchor.offsetParent) {
 			do {
@@ -268,7 +271,10 @@
 			} while (anchor);
 		}
 		location = Math.max(location - headerHeight - offset, 0);
-		return location;
+		if (clip) {
+			location = Math.min(location, getDocumentHeight() - window.innerHeight);
+		}
+ 		return location;
 	};
 
 	/**
@@ -405,7 +411,7 @@
 				// Get the height of a fixed header if one exists and not already set
 				headerHeight = getHeaderHeight(fixedHeader);
 			}
-			var endLocation = isNum ? anchor : getEndLocation(anchorElem, headerHeight, parseInt((typeof animateSettings.offset === 'function' ? animateSettings.offset(anchor, toggle) : animateSettings.offset), 10)); // Location to scroll to
+			var endLocation = isNum ? anchor : getEndLocation(anchorElem, headerHeight, parseInt((typeof animateSettings.offset === 'function' ? animateSettings.offset(anchor, toggle) : animateSettings.offset), 10), animateSettings.clip); // Location to scroll to
 			var distance = endLocation - startLocation; // distance to travel
 			var documentHeight = getDocumentHeight();
 			var timeLapsed = 0;

dist/smooth-scroll.min.js

@@ -1,5 +1,5 @@
 /*!
- * smooth-scroll v14.1.1: Animate scrolling to anchor links
+ * smooth-scroll v14.2.0: Animate scrolling to anchor links
  * (c) 2018 Chris Ferdinandi
  * MIT License
  * http://github.com/cferdinandi/smooth-scroll
@@ -101,6 +101,7 @@ if (window.Element && !Element.prototype.closest) {
 
 		// Speed & Easing
 		speed: 500,
+		clip: true,
 		offset: 0,
 		easing: 'easeInOutCubic',
 		customEasing: null,
@@ -324,12 +325,14 @@ if (window.Element && !Element.prototype.closest) {
 
 	/**
 	 * Calculate how far to scroll
-	 * @param {Element} anchor The anchor element to scroll to
-	 * @param {Number} headerHeight Height of a fixed header, if any
-	 * @param {Number} offset Number of pixels by which to offset scroll
+	 * Clip support added by robjtede - https://github.com/cferdinandi/smooth-scroll/issues/405
+	 * @param {Element} anchor       The anchor element to scroll to
+	 * @param {Number}  headerHeight Height of a fixed header, if any
+	 * @param {Number}  offset       Number of pixels by which to offset scroll
+	 * @param {Boolean} clip         If true, adjust scroll distance to prevent abrupt stops near the bottom of the page
 	 * @returns {Number}
 	 */
-	var getEndLocation = function (anchor, headerHeight, offset) {
+	var getEndLocation = function (anchor, headerHeight, offset, clip) {
 		var location = 0;
 		if (anchor.offsetParent) {
 			do {
@@ -338,7 +341,10 @@ if (window.Element && !Element.prototype.closest) {
 			} while (anchor);
 		}
 		location = Math.max(location - headerHeight - offset, 0);
-		return location;
+		if (clip) {
+			location = Math.min(location, getDocumentHeight() - window.innerHeight);
+		}
+ 		return location;
 	};
 
 	/**
@@ -475,7 +481,7 @@ if (window.Element && !Element.prototype.closest) {
 				// Get the height of a fixed header if one exists and not already set
 				headerHeight = getHeaderHeight(fixedHeader);
 			}
-			var endLocation = isNum ? anchor : getEndLocation(anchorElem, headerHeight, parseInt((typeof animateSettings.offset === 'function' ? animateSettings.offset(anchor, toggle) : animateSettings.offset), 10)); // Location to scroll to
+			var endLocation = isNum ? anchor : getEndLocation(anchorElem, headerHeight, parseInt((typeof animateSettings.offset === 'function' ? animateSettings.offset(anchor, toggle) : animateSettings.offset), 10), animateSettings.clip); // Location to scroll to
 			var distance = endLocation - startLocation; // distance to travel
 			var documentHeight = getDocumentHeight();
 			var timeLapsed = 0;