- ' + toc + '
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/dist/js/smooth-scroll.js b/docs/dist/js/smooth-scroll.js
deleted file mode 100755
index af2c9e0..0000000
--- a/docs/dist/js/smooth-scroll.js
+++ /dev/null
@@ -1,599 +0,0 @@
-/*!
- * smooth-scroll v11.1.0: Animate scrolling to anchor links
- * (c) 2017 Chris Ferdinandi
- * GPL-3.0 License
- * http://github.com/cferdinandi/smooth-scroll
- */
-
-(function (root, factory) {
- if ( typeof define === 'function' && define.amd ) {
- define([], factory(root));
- } else if ( typeof exports === 'object' ) {
- module.exports = factory(root);
- } else {
- root.smoothScroll = factory(root);
- }
-})(typeof global !== 'undefined' ? global : this.window || this.global, (function (root) {
-
- 'use strict';
-
- //
- // Variables
- //
-
- var smoothScroll = {}; // Object for public APIs
- var supports = 'querySelector' in document && 'addEventListener' in root; // Feature test
- var settings, anchor, toggle, fixedHeader, headerHeight, eventTimeout, animationInterval;
-
- // Default settings
- var defaults = {
- // Selectors
- selector: '[data-scroll]',
- ignore: '[data-scroll-ignore]',
- selectorHeader: null,
-
- // Speed & Easing
- speed: 500,
- offset: 0,
- easing: 'easeInOutCubic',
- easingPatterns: {},
-
- // Callback API
- before: function () {},
- after: function () {}
- };
-
-
- //
- // Methods
- //
-
- /**
- * Merge two or more objects. Returns a new object.
- * @private
- * @param {Boolean} deep If true, do a deep (or recursive) merge [optional]
- * @param {Object} objects The objects to merge together
- * @returns {Object} Merged values of defaults and options
- */
- var extend = function () {
-
- // Variables
- var extended = {};
- var deep = false;
- var i = 0;
- var length = arguments.length;
-
- // Check if a deep merge
- if ( Object.prototype.toString.call( arguments[0] ) === '[object Boolean]' ) {
- deep = arguments[0];
- i++;
- }
-
- // Merge the object into the extended object
- var merge = function (obj) {
- for ( var prop in obj ) {
- if ( Object.prototype.hasOwnProperty.call( obj, prop ) ) {
- // If deep merge and property is an object, merge properties
- if ( deep && Object.prototype.toString.call(obj[prop]) === '[object Object]' ) {
- extended[prop] = extend( true, extended[prop], obj[prop] );
- } else {
- extended[prop] = obj[prop];
- }
- }
- }
- };
-
- // Loop through each object and conduct a merge
- for ( ; i < length; i++ ) {
- var obj = arguments[i];
- merge(obj);
- }
-
- return extended;
-
- };
-
- /**
- * Get the height of an element.
- * @private
- * @param {Node} elem The element to get the height of
- * @return {Number} The element's height in pixels
- */
- var getHeight = function ( elem ) {
- return Math.max( elem.scrollHeight, elem.offsetHeight, elem.clientHeight );
- };
-
- /**
- * Get the closest matching element up the DOM tree.
- * @private
- * @param {Element} elem Starting element
- * @param {String} selector Selector to match against
- * @return {Boolean|Element} Returns null if not match found
- */
- var getClosest = function ( elem, selector ) {
-
- // Element.matches() polyfill
- if (!Element.prototype.matches) {
- Element.prototype.matches =
- Element.prototype.matchesSelector ||
- Element.prototype.mozMatchesSelector ||
- Element.prototype.msMatchesSelector ||
- Element.prototype.oMatchesSelector ||
- Element.prototype.webkitMatchesSelector ||
- function(s) {
- var matches = (this.document || this.ownerDocument).querySelectorAll(s),
- i = matches.length;
- while (--i >= 0 && matches.item(i) !== this) {}
- return i > -1;
- };
- }
-
- // Get closest match
- for ( ; elem && elem !== document; elem = elem.parentNode ) {
- if ( elem.matches( selector ) ) return elem;
- }
-
- return null;
-
- };
-
- /**
- * Escape special characters for use with querySelector
- * @private
- * @param {String} id The anchor ID to escape
- * @author Mathias Bynens
- * @link https://github.com/mathiasbynens/CSS.escape
- */
- var escapeCharacters = function ( id ) {
-
- // Remove leading hash
- if ( id.charAt(0) === '#' ) {
- id = id.substr(1);
- }
-
- var string = String(id);
- var length = string.length;
- var index = -1;
- var codeUnit;
- var result = '';
- var firstCodeUnit = string.charCodeAt(0);
- while (++index < length) {
- codeUnit = string.charCodeAt(index);
- // Note: there’s no need to special-case astral symbols, surrogate
- // pairs, or lone surrogates.
-
- // If the character is NULL (U+0000), then throw an
- // `InvalidCharacterError` exception and terminate these steps.
- if (codeUnit === 0x0000) {
- throw new InvalidCharacterError(
- 'Invalid character: the input contains U+0000.'
- );
- }
-
- if (
- // If the character is in the range [\1-\1F] (U+0001 to U+001F) or is
- // U+007F, […]
- (codeUnit >= 0x0001 && codeUnit <= 0x001F) || codeUnit == 0x007F ||
- // If the character is the first character and is in the range [0-9]
- // (U+0030 to U+0039), […]
- (index === 0 && codeUnit >= 0x0030 && codeUnit <= 0x0039) ||
- // If the character is the second character and is in the range [0-9]
- // (U+0030 to U+0039) and the first character is a `-` (U+002D), […]
- (
- index === 1 &&
- codeUnit >= 0x0030 && codeUnit <= 0x0039 &&
- firstCodeUnit === 0x002D
- )
- ) {
- // http://dev.w3.org/csswg/cssom/#escape-a-character-as-code-point
- result += '\\' + codeUnit.toString(16) + ' ';
- continue;
- }
-
- // If the character is not handled by one of the above rules and is
- // greater than or equal to U+0080, is `-` (U+002D) or `_` (U+005F), or
- // is in one of the ranges [0-9] (U+0030 to U+0039), [A-Z] (U+0041 to
- // U+005A), or [a-z] (U+0061 to U+007A), […]
- if (
- codeUnit >= 0x0080 ||
- codeUnit === 0x002D ||
- codeUnit === 0x005F ||
- codeUnit >= 0x0030 && codeUnit <= 0x0039 ||
- codeUnit >= 0x0041 && codeUnit <= 0x005A ||
- codeUnit >= 0x0061 && codeUnit <= 0x007A
- ) {
- // the character itself
- result += string.charAt(index);
- continue;
- }
-
- // Otherwise, the escaped character.
- // http://dev.w3.org/csswg/cssom/#escape-a-character
- result += '\\' + string.charAt(index);
-
- }
-
- return '#' + result;
-
- };
-
- /**
- * Calculate the easing pattern
- * @private
- * @link https://gist.github.com/gre/1650294
- * @param {String} type Easing pattern
- * @param {Number} time Time animation should take to complete
- * @returns {Number}
- */
- var easingPattern = function ( settings, time ) {
- var pattern;
-
- // Default Easing Patterns
- if ( settings.easing === 'easeInQuad' ) pattern = time * time; // accelerating from zero velocity
- if ( settings.easing === 'easeOutQuad' ) pattern = time * (2 - time); // decelerating to zero velocity
- if ( settings.easing === 'easeInOutQuad' ) pattern = time < 0.5 ? 2 * time * time : -1 + (4 - 2 * time) * time; // acceleration until halfway, then deceleration
- if ( settings.easing === 'easeInCubic' ) pattern = time * time * time; // accelerating from zero velocity
- if ( settings.easing === 'easeOutCubic' ) pattern = (--time) * time * time + 1; // decelerating to zero velocity
- if ( settings.easing === 'easeInOutCubic' ) pattern = time < 0.5 ? 4 * time * time * time : (time - 1) * (2 * time - 2) * (2 * time - 2) + 1; // acceleration until halfway, then deceleration
- if ( settings.easing === 'easeInQuart' ) pattern = time * time * time * time; // accelerating from zero velocity
- if ( settings.easing === 'easeOutQuart' ) pattern = 1 - (--time) * time * time * time; // decelerating to zero velocity
- if ( settings.easing === 'easeInOutQuart' ) pattern = time < 0.5 ? 8 * time * time * time * time : 1 - 8 * (--time) * time * time * time; // acceleration until halfway, then deceleration
- if ( settings.easing === 'easeInQuint' ) pattern = time * time * time * time * time; // accelerating from zero velocity
- if ( settings.easing === 'easeOutQuint' ) pattern = 1 + (--time) * time * time * time * time; // decelerating to zero velocity
- if ( settings.easing === 'easeInOutQuint' ) pattern = time < 0.5 ? 16 * time * time * time * time * time : 1 + 16 * (--time) * time * time * time * time; // acceleration until halfway, then deceleration
-
- // Custom Easing Patterns
- if ( settings.easingPatterns[settings.easing] ) {
- pattern = settings.easingPatterns[settings.easing]( time );
- }
-
- return pattern || time; // no easing, no acceleration
- };
-
- /**
- * Calculate how far to scroll
- * @private
- * @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
- * @returns {Number}
- */
- var getEndLocation = function ( anchor, headerHeight, offset ) {
- var location = 0;
- if (anchor.offsetParent) {
- do {
- location += anchor.offsetTop;
- anchor = anchor.offsetParent;
- } while (anchor);
- }
- location = Math.max(location - headerHeight - offset, 0);
- return Math.min(location, getDocumentHeight() - getViewportHeight());
- };
-
- /**
- * Determine the viewport's height
- * @private
- * @returns {Number}
- */
- var getViewportHeight = function() {
- return Math.max( document.documentElement.clientHeight, root.innerHeight || 0 );
- };
-
- /**
- * Determine the document's height
- * @private
- * @returns {Number}
- */
- var getDocumentHeight = function () {
- return Math.max(
- document.body.scrollHeight, document.documentElement.scrollHeight,
- document.body.offsetHeight, document.documentElement.offsetHeight,
- document.body.clientHeight, document.documentElement.clientHeight
- );
- };
-
- /**
- * Convert data-options attribute into an object of key/value pairs
- * @private
- * @param {String} options Link-specific options as a data attribute string
- * @returns {Object}
- */
- var getDataOptions = function ( options ) {
- return !options || !(typeof JSON === 'object' && typeof JSON.parse === 'function') ? {} : JSON.parse( options );
- };
-
- /**
- * Get the height of the fixed header
- * @private
- * @param {Node} header The header
- * @return {Number} The height of the header
- */
- var getHeaderHeight = function ( header ) {
- return !header ? 0 : ( getHeight( header ) + header.offsetTop );
- };
-
- /**
- * Bring the anchored element into focus
- * @private
- */
- var adjustFocus = function ( anchor, endLocation, isNum ) {
-
- // Don't run if scrolling to a number on the page
- if ( isNum ) return;
-
- // Otherwise, bring anchor element into focus
- anchor.focus();
- if ( document.activeElement.id !== anchor.id ) {
- anchor.setAttribute( 'tabindex', '-1' );
- anchor.focus();
- anchor.style.outline = 'none';
- }
- root.scrollTo( 0 , endLocation );
-
- };
-
- /**
- * Start/stop the scrolling animation
- * @public
- * @param {Node|Number} anchor The element or position to scroll to
- * @param {Element} toggle The element that toggled the scroll event
- * @param {Object} options
- */
- smoothScroll.animateScroll = function ( anchor, toggle, options ) {
-
- // Options and overrides
- var overrides = getDataOptions( toggle ? toggle.getAttribute('data-options') : null );
- var animateSettings = extend( settings || defaults, options || {}, overrides ); // Merge user options with defaults
-
- // Selectors and variables
- var isNum = Object.prototype.toString.call( anchor ) === '[object Number]' ? true : false;
- var anchorElem = isNum || !anchor.tagName ? null : anchor;
- if ( !isNum && !anchorElem ) return;
- var startLocation = root.pageYOffset; // Current location on the page
- if ( animateSettings.selectorHeader && !fixedHeader ) {
- // Get the fixed header if not already set
- fixedHeader = document.querySelector( animateSettings.selectorHeader );
- }
- if ( !headerHeight ) {
- // 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() : animateSettings.offset), 10) ); // Location to scroll to
- var distance = endLocation - startLocation; // distance to travel
- var documentHeight = getDocumentHeight();
- var timeLapsed = 0;
- var percentage, position;
-
- /**
- * Stop the scroll animation when it reaches its target (or the bottom/top of page)
- * @private
- * @param {Number} position Current position on the page
- * @param {Number} endLocation Scroll to location
- * @param {Number} animationInterval How much to scroll on this loop
- */
- var stopAnimateScroll = function ( position, endLocation, animationInterval ) {
- var currentLocation = root.pageYOffset;
- if ( position == endLocation || currentLocation == endLocation || ( (root.innerHeight + currentLocation) >= documentHeight ) ) {
-
- // Clear the animation timer
- clearInterval(animationInterval);
-
- // Bring the anchored element into focus
- adjustFocus( anchor, endLocation, isNum );
-
- // Run callback after animation complete
- animateSettings.after( anchor, toggle );
-
- }
- };
-
- /**
- * Loop scrolling animation
- * @private
- */
- var loopAnimateScroll = function () {
- timeLapsed += 16;
- percentage = ( timeLapsed / parseInt(animateSettings.speed, 10) );
- percentage = ( percentage > 1 ) ? 1 : percentage;
- position = startLocation + ( distance * easingPattern(animateSettings, percentage) );
- root.scrollTo( 0, Math.floor(position) );
- stopAnimateScroll(position, endLocation, animationInterval);
- };
-
- /**
- * Set interval timer
- * @private
- */
- var startAnimateScroll = function () {
- clearInterval(animationInterval);
- animationInterval = setInterval(loopAnimateScroll, 16);
- };
-
- /**
- * Reset position to fix weird iOS bug
- * @link https://github.com/cferdinandi/smooth-scroll/issues/45
- */
- if ( root.pageYOffset === 0 ) {
- root.scrollTo( 0, 0 );
- }
-
- // Run callback before animation starts
- animateSettings.before( anchor, toggle );
-
- // Start scrolling animation
- startAnimateScroll();
-
- };
-
- /**
- * Handle has change event
- * @private
- */
- var hashChangeHandler = function (event) {
-
- // Get hash from URL
- var hash;
- try {
- hash = escapeCharacters( decodeURIComponent( root.location.hash ) );
- } catch(e) {
- hash = escapeCharacters( root.location.hash );
- }
-
- // Only run if there's an anchor element to scroll to
- if ( !anchor ) return;
-
- // Reset the anchor element's ID
- anchor.id = anchor.getAttribute( 'data-scroll-id' );
-
- // Scroll to the anchored content
- smoothScroll.animateScroll( anchor, toggle );
-
- // Reset anchor and toggle
- anchor = null;
- toggle = null;
-
- };
-
- /**
- * If smooth scroll element clicked, animate scroll
- * @private
- */
- var clickHandler = function (event) {
-
- // Don't run if right-click or command/control + click
- if ( event.button !== 0 || event.metaKey || event.ctrlKey ) return;
-
- // Check if a smooth scroll link was clicked
- toggle = getClosest( event.target, settings.selector );
- if ( !toggle || toggle.tagName.toLowerCase() !== 'a' || getClosest( event.target, settings.ignore ) ) return;
-
- // Only run if link is an anchor and points to the current page
- if ( toggle.hostname !== root.location.hostname || toggle.pathname !== root.location.pathname || !/#/.test(toggle.href) ) return;
-
- // Get the sanitized hash
- var hash;
- try {
- hash = escapeCharacters( decodeURIComponent( toggle.hash ) );
- } catch(e) {
- hash = escapeCharacters( toggle.hash );
- }
-
- // If the hash is empty, scroll to the top of the page
- if ( hash === '#' ) {
-
- // Prevent default link behavior
- event.preventDefault();
-
- // Set the anchored element
- anchor = document.body;
-
- // Save or create the ID as a data attribute and remove it (prevents scroll jump)
- var id = anchor.id ? anchor.id : 'smooth-scroll-top';
- anchor.setAttribute( 'data-scroll-id', id );
- anchor.id = '';
-
- // If no hash change event will happen, fire manually
- // Otherwise, update the hash
- if ( root.location.hash.substring(1) === id ) {
- hashChangeHandler();
- } else {
- root.location.hash = id;
- }
-
- return;
-
- }
-
- // Get the anchored element
- anchor = document.querySelector( hash );
-
- // If anchored element exists, save the ID as a data attribute and remove it (prevents scroll jump)
- if ( !anchor ) return;
- anchor.setAttribute( 'data-scroll-id', anchor.id );
- anchor.id = '';
-
- // If no hash change event will happen, fire manually
- if ( toggle.hash === root.location.hash ) {
- event.preventDefault();
- hashChangeHandler();
- }
-
- };
-
- /**
- * On window scroll and resize, only run events at a rate of 15fps for better performance
- * @private
- * @param {Function} eventTimeout Timeout function
- * @param {Object} settings
- */
- var resizeThrottler = function (event) {
- if ( !eventTimeout ) {
- eventTimeout = setTimeout((function() {
- eventTimeout = null; // Reset timeout
- headerHeight = getHeaderHeight( fixedHeader ); // Get the height of a fixed header if one exists
- }), 66);
- }
- };
-
- /**
- * Destroy the current initialization.
- * @public
- */
- smoothScroll.destroy = function () {
-
- // If plugin isn't already initialized, stop
- if ( !settings ) return;
-
- // Remove event listeners
- document.removeEventListener( 'click', clickHandler, false );
- root.removeEventListener( 'resize', resizeThrottler, false );
-
- // Reset varaibles
- settings = null;
- anchor = null;
- toggle = null;
- fixedHeader = null;
- headerHeight = null;
- eventTimeout = null;
- animationInterval = null;
- };
-
- /**
- * Initialize Smooth Scroll
- * @public
- * @param {Object} options User settings
- */
- smoothScroll.init = function ( options ) {
-
- // feature test
- if ( !supports ) return;
-
- // Destroy any existing initializations
- smoothScroll.destroy();
-
- // Selectors and variables
- settings = extend( defaults, options || {} ); // Merge user options with defaults
- fixedHeader = settings.selectorHeader ? document.querySelector( settings.selectorHeader ) : null; // Get the fixed header
- headerHeight = getHeaderHeight( fixedHeader );
-
- // When a toggle is clicked, run the click handler
- document.addEventListener( 'click', clickHandler, false );
-
- // Listen for hash changes
- root.addEventListener('hashchange', hashChangeHandler, false);
-
- // If window is resized and there's a fixed header, recalculate its size
- if ( fixedHeader ) {
- root.addEventListener( 'resize', resizeThrottler, false );
- }
-
- };
-
-
- //
- // Public APIs
- //
-
- return smoothScroll;
-
-}));
\ No newline at end of file
diff --git a/docs/dist/js/smooth-scroll.min.js b/docs/dist/js/smooth-scroll.min.js
deleted file mode 100755
index b0b54aa..0000000
--- a/docs/dist/js/smooth-scroll.min.js
+++ /dev/null
@@ -1,2 +0,0 @@
-/*! smooth-scroll v11.1.0 | (c) 2017 Chris Ferdinandi | GPL-3.0 License | http://github.com/cferdinandi/smooth-scroll */
-!(function(e,t){"function"==typeof define&&define.amd?define([],t(e)):"object"==typeof exports?module.exports=t(e):e.smoothScroll=t(e)})("undefined"!=typeof global?global:this.window||this.global,(function(e){"use strict";var t,n,o,r,a,i,c,l={},s="querySelector"in document&&"addEventListener"in e,u={selector:"[data-scroll]",ignore:"[data-scroll-ignore]",selectorHeader:null,speed:500,offset:0,easing:"easeInOutCubic",easingPatterns:{},before:function(){},after:function(){}},f=function(){var e={},t=!1,n=0,o=arguments.length;"[object Boolean]"===Object.prototype.toString.call(arguments[0])&&(t=arguments[0],n++);for(;n
-
-
-
-
-
-
-
-
- - -
-
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Browser Compatibility
-Supported Browsers
-Smooth Scroll works in all modern browsers, and IE 9 and above.
-Smooth Scroll is built with modern JavaScript APIs, and uses progressive enhancement. If the JavaScript file fails to load, or if your site is viewed on older and less capable browsers, anchor links will jump the way they normally would.
-- - -
Known Issues
-<body> styling
-If the <body> element has been assigned a height of 100% or overflow: hidden, Smooth Scroll is unable to properly calculate page distances and will not scroll to the right location. The <body> element can have a fixed, non-percentage based height (ex. 500px), or a height of auto, and an overflow of visible.
Animating from the bottom
-Animated scrolling links at the very bottom of the page (example: a "scroll to top" link) will stop animated almost immediately after they start when using certain easing patterns. This is an issue that's been around for a while and I've yet to find a good fix for it. I've found that easeOut* easing patterns work as expected, but other patterns can cause issues. See this discussion for more details.
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100755
index 6905013..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,161 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
- -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Extras
-Frequently asked questions, code snippets, and more to help you get the most out of Smooth Scroll.
-- -
Scrolling to an anchor link on another page
-This, unfortunately, cannot be done well.
-Most browsers instantly jump you to the anchor location when you load a page. You could use scrollTo(0, 0) to pull users back up to the top, and then manually use the smoothScroll.animateScroll() method, but in my experience, it results in a visible jump on the page that's a worse experience than the default browser behavior.
- -
Scrolling without updating the URL
-Smooth Scroll is designed to progressively enhance anchor links while offloading as much to the browser as possible. In it's current implementation, it relies on hashchange events (which occur whenever a # changes in the URL) to trigger the scrolling behavior.
A benefit of this approach is that it preserves browser history and let's users navigate between anchors with the forward and back buttons on the browsers, just like you would normally.
-However, I know certain front-end frameworks also use URL hashes for their own internal processes. While I view this as an anti-pattern, and won't bake hashless anchor links into Smooth Scroll's core, you can enable scrolling without updating the URL via the Smooth Scroll API.
-Here's a relatively lightweight helper function that listens for click events and uses the smoothScroll.animateScroll() method to scroll to the anchor. If you use this, you should not need initialize Smooth Scroll with smoothScroll.init().
var smoothScrollWithoutHash = function (selector, settings) {
-
- /**
- * Get the closest matching element up the DOM tree.
- * @private
- * @param {Element} elem Starting element
- * @param {String} selector Selector to match against
- * @return {Boolean|Element} Returns null if not match found
- */
- var getClosest = function ( elem, selector ) {
-
- // Element.matches() polyfill
- if (!Element.prototype.matches) {
- Element.prototype.matches =
- Element.prototype.matchesSelector ||
- Element.prototype.mozMatchesSelector ||
- Element.prototype.msMatchesSelector ||
- Element.prototype.oMatchesSelector ||
- Element.prototype.webkitMatchesSelector ||
- function(s) {
- var matches = (this.document || this.ownerDocument).querySelectorAll(s),
- i = matches.length;
- while (--i >= 0 && matches.item(i) !== this) {}
- return i > -1;
- };
- }
-
- // Get closest match
- for ( ; elem && elem !== document; elem = elem.parentNode ) {
- if ( elem.matches( selector ) ) return elem;
- }
-
- return null;
-
- };
-
-
- /**
- * If smooth scroll element clicked, animate scroll
- * @private
- */
- var clickHandler = function (event) {
- var toggle = getClosest( event.target, selector );
- console.log(toggle);
- if ( !toggle || toggle.tagName.toLowerCase() !== 'a' ) return;
- console.log(toggle.hash);
- var anchor = document.querySelector( toggle.hash );
- if ( !anchor ) return;
-
- event.preventDefault(); // Prevent default click event
- smoothScroll.animateScroll( anchor, toggle, settings || {} ); // Animate scroll
- };
-
- window.addEventListener('click', clickHandler, false );
-
-};
-
-// Run our function
-smoothScrollWithoutHash( 'a[href*="#"]' );
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/license.html b/docs/license.html
deleted file mode 100755
index b5ffc56..0000000
--- a/docs/license.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Smooth Scroll
-Smooth Scroll is a lightweight script to animate scrolling to anchor links. It works great with Gumshoe.
-- -
Demo
-
- Linear
- Linear (no other options)
-
- Ease-In
- Quad
- Cubic
- Quart
- Quint
-
- Ease-In-Out
- Quad
- Cubic
- Quart
- Quint
-
- Ease-Out
- Quad
- Cubic
- Quart
- Quint
-
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
-
- Non-ASCII Characters
- ä¸ć–‡
-
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
-
ä¸ć–‡
- - - -
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
- .
.
.
.
.
.
.
.
.
.
.
.
.
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/options.html b/docs/options.html
deleted file mode 100755
index f5965ff..0000000
--- a/docs/options.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
- - -
-
-
-
-
- - -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-License
-Smooth Scroll has three types of licenses:
--
-
- Open Source, for personal and open source projects. -
- Commercial, for commercial projects and applications. -
- OEM, for when this Smooth Scroll will be bundled with a commercial interface builder, SDK, or toolkit. -
- - -
Open Source License
-If you're looking to use Smooth Scroll on an open source or personal project, the code is available under the GPLv3 License. GPLv3 has many terms, but the most important one is that it requires you to license you entire project under the terms of GPLv3 as well:
---You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged.
-
You can absolutely use the open source license for commercial projects, but those projects must also be open sourced in their entirety with a GPLv3 license.
-- - -
Commercial License
-The Commercial License let's you use Smooth Scroll in commercial projects and applications without the provisions of GPLv3. With this license, your code is kept proprietary.
--
-
- You can modify the source code. -
- You can include it in your own commercial products and applications, such as premium CMS themes, plugins, or templates. -
- Customers and users of your products do not need to purchase their own license, as long as they're not developing their own commercial products with Smooth Scroll. -
Buy a Commercial License
-Commercial Licenses are priced based on the number of websites, applications, or other products that use Smooth Scroll. Pay with credit card and instantly receive a PDF of your Commercial License.
-| Description | -Price | -
|---|---|
| 1 Site or App | -Buy a 1 Site License now for $29 | -
| 5 Sites or Apps | -Buy a 5 Site License now for $59 | -
| 25 Sites or Apps | -Buy a 25 Site License now for $119 | -
You can read the full text of the Commercial License below. Email me at chris@gomakethings.com with any questions you have about licensing.
-The Commercial License Agreement
-This Software License Agreement (the “Agreement”) is between Go Make Things, LLC (“Go Make Things”) and You (including your agents and affiliates), a commercial licensee of Go Make Things's software. If you have not purchased a Smooth Scroll Commercial License from Go Make Things, these terms do not apply to you, and your use of the Go Make Things software is instead governed by the GNU General Public License, version 3.
-1. Definitions
--
-
- “Application” means any software, application, or elements that Your Licensed Developers develop using the Software or Modifications in accordance with this Agreement. -
- “End User” means an end user of Your Application who acquires a license to such solely for their own use and not for distribution, resale, user interface design, or software development purposes. -
- “Licensed Developer” shall mean an individual person permitted to use the Software and make Modifications for your Applications, whether such person is Your employee or a consultant or contractor providing services to You. -
- “Modification” means any revision, adaptation, or derivative of the Software produced by You. -
- The “Software” means Smooth Scroll version 11. -
2. Commercial license grant
-Subject to the terms of this Agreement, Go Make Things grants to You a revocable, non-exclusive, non-transferable license:
--
-
- for Licensed Developers to use the Software to create Modifications and [n—varies based on the license you purchase] Applications; -
- for You to distribute the Software and/or Modifications to an unlimited number of End Users solely as integrated into the Applications; -
- and for End Users to use the Software as incorporated into Your Applications in accordance with the terms of this Agreement. -
You are entitled to receive all updates to the major version of the Software licensed by you, as well as any later version of the Software that Go Make Things, in writing, explicitly authorizes you to use. (For illustration purposes only, if you purchased a license for version 2.0, this licenses authorizes you to use version 2.9, but not 3.0.) Go Make Things makes no representation that any update will be compatible with your Application.
-3. Ownership
-This is a license agreement and not an agreement for sale. Go Make Things reserves ownership of all intellectual property rights inherent in or relating to the Software and corresponding source code, which include all copyright, patent rights, all rights in relation to registered and unregistered trademarks (including service marks), confidential information (including trade secrets and know-how) and all rights other than those expressly granted by this Agreement.
-You must not remove, obscure or interfere with any copyright, acknowledgment, attribution, trademark, warning or disclaimer statement affixed to, incorporated in or otherwise applied in connection with the Software. Notwithstanding the above, you are permitted to produce, use, and distribute compressed or “minified” copies of the Software that do not bear the notices contained in the Software’s source code, so long as you otherwise comply with the terms of this license.
-4. Prohibited Uses
-Your Application must have substantially different functionality than, and must not compete directly with, the Software.
-You may not distribute the Software or Modifications except as included within Your Application.
-If You produce an Application for a customer, You are responsible for ensuring that your customer does not make use of the Software except with Applications licensed herein.
-Your Application must not enable End Users to produce separate applications that incorporate the Software or Modifications. For example, if Your Application is a development toolkit or library, an application builder, a website builder that can be used to incorporate the Software into a new Application, You must obtain a separate OEM license from Go Make Things.
-5. Termination
-This Agreement and the license granted hereunder shall continue until terminated in accordance with this Section. Unless otherwise specified in this Agreement, the license shall last as long as Your use of the Software is in compliance with the terms herein.
-Go Make Things shall have the right to terminate this Agreement and the license granted hereunder immediately if You breach any of the material terms of this Agreement. Upon termination of this Agreement, all licenses granted to You in this Agreement shall terminate automatically and You shall immediately cease use and distribution of the Software.
-Upon termination of this Agreement, You must cease all use of the Software. If, prior to your breach of this Agreement, you delivered Applications incorporating the Software to Your End Users, those End Users’ licenses shall survive termination.
-6. Disclaimer of Warranties
-TO THE EXTENT PERMITTED BY LAW, GO MAKE THINGS DISCLAIMS ALL WARRANTIES AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE. WE DO NOT GUARANTEE THAT THE OPERATION OF THE SOFTWARE OR YOUR APPLICATION WILL BE UNINTERRUPTED OR ERROR-FREE, AND YOU ACKNOWLEDGE THAT IT IS NOT TECHNICALLY PRACTICABLE FOR US TO DO SO.
-7. Limitation of Liabilities
-TO THE EXTENT PERMITTED BY LAW, IN NO EVENT SHALL GO MAKE THINGS BE LIABLE UNDER ANY LEGAL OR EQUITABLE THEORY FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LAW) ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE OR THE CODE IT PRODUCES OR ANY OTHER SUBJECT MATTER RELATING TO THIS AGREEMENT, EVEN IF GO MAKE THINGS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN ANY CASE, GO MAKE THINGS’S ENTIRE LIABILITY WITH RESPECT TO ANY SUBJECT MATTER RELATING TO THIS AGREEMENT SHALL BE LIMITED TO THE GREATER OF: (I) THE AMOUNT ACTUALLY PAID BY YOU FOR THE LICENSE, OR (II) FIVE HUNDRED DOLLARS ($500).
-8. Indemnification
-While redistributing the Software or Modifications thereof as part of Your Application, You may choose to offer acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this Agreement. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, and not on Go Make Things’s behalf.
-You agree to indemnify, hold harmless, and defend Go Make Things and its owners, officers, agents, and affiliates from and against any and all claims, lawsuits and proceedings (collectively “Claims”), and all expenses, costs (including attorney's fees), judgments, damages and other liabilities resulting from such Claims, that arise or result from:
--
-
- your use of the Software in violation of this Agreement; -
- the use or distribution of Your Application, except to the extent such claim is based solely on the inclusion of the Software therein; -
- your Modification of the Software’s source code; or -
- your accepting support, warranty, indemnity, or additional liability as described in the preceding paragraph. -
9. Payment and Taxes
-All payments under this Agreement are due to Go Make Things upon Your purchase of a license to the Software.
-Each party shall be responsible for all taxes (including, but not limited to, taxes based upon its income) or levies imposed on it under applicable laws, regulations and tax treaties as a result of this Agreement and any payments made hereunder (including those required to be withheld or deducted from payments); provided that You shall be responsible for any value added tax, use tax, sales tax, or similar tax, and shall pay or reimburse Go Make Things for the same upon invoice. Each party shall furnish evidence of such paid taxes as is sufficient to enable the other party to obtain any credits available to it, including original tax withholding certificates.
-10. Miscellaneous
-Software Updates and Upgrades. The license granted herein applies only to the version of the Software available when purchased in connection with the terms of this Agreement, and to any updates and/or upgrades to which You may be entitled. Any previous or subsequent license granted to You for use of the Software shall be governed by the terms and conditions of the agreement entered in connection with purchase or download of that version of the Software.
-Survival. The provisions of sections 4 through 10 will survive termination of this Agreement.
-Compliance with Applicable Laws. You agree that You will comply with all applicable laws and regulations with respect to the Software, including without limitation all export control laws and regulations.
-Marketing. You agree to Go Make Things’s use of Your name, trade name, and trademark, for use in Go Make Things’s marketing materials and its website, solely to identify you as a customer of Go Make Things.
-Assignment. This Agreement may be assigned by Go Make Things in whole or in part and will inure to the benefit of Go Make Things’s successors and assigns. You may not assign or transfer this Agreement without Go Make Things’s prior written consent. Notwithstanding the foregoing, however, if You transfer ownership of an Application to a customer for which it was developed, You may assign this Agreement to that customer (the “Assignee”) provided:
--
-
- You provide written notice to Go Make Things prior to the effective date of such assignment; and -
- there is a written agreement, wherein the Assignee accepts the terms of this Agreement. -
Entire Agreement. The terms and conditions stated herein set forth the entire agreement of the parties and replace and supersede all other contracts, agreements, and understandings, written or oral, relating to the subject matter hereof.
-Severability. In the event that any portion of this Agreement is held to be unenforceable, such portions shall not limit or otherwise modify or affect any other portion of this Agreement.
-Modification; Waiver. This Agreement cannot be amended except by a written instrument executed by Go Make Things.

 All Additional Terms are hereby incorporated into this Agreement by this reference.

 The failure of Go Make Things to enforce any provision of this Agreement may not be deemed a waiver of that or any other provision of this Agreement.
-Governing Law. This Agreement is subject to, and shall be interpreted and enforced in accordance with, the laws of the Commonwealth of Massachusetts in all respects without regard to conflict of law principles. The Courts of Bristol County, Massachusetts and Norfolk County, Massachusetts shall be the sole and exclusive Courts in which either party may attempt to enforce or establish the existence or scope of any rights, benefits or obligations under this Agreement. The UN Convention on Contracts for the International Sale of Goods is expressly excluded.
-Government Use. If the Software or any related documentation is licensed to the U.S. Government or any agency thereof, it will be considered to be “commercial computer software” or “commercial computer software documentation,” as those terms are used in 48 CFR § 12.212 or 48 CFR § 227.7202, and is being licensed with only those rights as are granted to all other licensees as set forth in this Agreement.
-- - -
OEM License
-If you'll be including Smooth Scroll in a project that can be used to build new products, websites, or applications—such as a commercial interface builder, SDK, or toolkit—you need to purchase an OEM License.
-The OEM License is customized for you. Please content me chris@gomakethings.com to discuss your project.
- - - -
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/setup.html b/docs/setup.html
deleted file mode 100755
index e9653ed..0000000
--- a/docs/setup.html
+++ /dev/null
@@ -1,148 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
- - -
- - -
- - -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Options and Settings
-Smooth Scroll includes smart defaults and works right out of the box. But if you want to customize things, it also has a robust API that provides multiple ways for you to adjust the default options and settings.
-- -
Global Settings
-You can pass options and callbacks into Smooth Scroll through the init() function:
smoothScroll.init({
- // Selectors
- selector: '[data-scroll]', // Selector for links (must be a valid CSS selector)
- ignore: '[data-scroll-ignore]' // Selector to ignore (won't animate scrolling on links with this selector)
- selectorHeader: null, // Selector for fixed headers (must be a valid CSS selector) [optional]
-
- // Speed & Easing
- speed: 500, // Integer. How fast to complete the scroll in milliseconds
- offset: 0, // Integer or Function returning an integer. How far to offset the scrolling anchor location in pixels
- easing: 'easeInOutCubic', // Easing pattern to use
-
- // Custom easing patterns.
- // Must be an object with the easing name as the key
- // Each pattern must be a function, with `time` as the argument, that returns the pattern
- easingPatterns: {
- myCustomEasingPattern: function (time) {
- return time * (2 - time);
- }
- }
-
- // Callback API
- before: function (anchor, toggle) {}, // Function to run before scrolling starts
- after: function (anchor, toggle) {} // Function to run after scrolling completes
-});
-Note: To programatically add Smooth Scroll to all anchor links on a page, pass selector: 'a[href*="#"]' into init.
Easing Options
-Linear -Moves at the same speed from start to finish.
--
-
Linear
-
Ease-In -Gradually increases in speed.
--
-
easeInQuad
-easeInCubic
-easeInQuart
-easeInQuint
-
Ease-In-Out -Gradually increases in speed, peaks, and then gradually slows down.
--
-
easeInOutQuad
-easeInOutCubic
-easeInOutQuart
-easeInOutQuint
-
Ease-Out -Gradually decreases in speed.
--
-
easeOutQuad
-easeOutCubic
-easeOutQuart
-easeOutQuint
-
Learn more about the different easing patterns and what they do at easings.net.
-- - -
Override settings with data attributes
-Smooth Scroll also lets you override global settings on a link-by-link basis using the [data-options] data attribute.
<a data-scroll
- data-options='{
- "speed": 500,
- "easing": "easeInOutCubic",
- "offset": 0
- }'
->
- Anchor Link
-</a>
-Note: You must use valid JSON in order for the data-options feature to work. Does not support the before and after callback methods, or the easingPatterns object.
- - -
Use Smooth Scroll events in your own scripts
-You can also call Smooth Scroll's scroll animation events in your own scripts.
-animateScroll()
-Animate scrolling to an anchor.
-smoothScroll.animateScroll(
- anchor, // Node to scroll to, OR an integer. ex. document.querySelector( '#bazinga' )
- toggle, // Node that toggles the animation. ex. document.querySelector( '#toggle' )
- options // Classes and callbacks. Same options as those passed into the init() function.
-);
-Example 1
-var anchor = document.querySelector( '#bazinga' );
-smoothScroll.animateScroll( anchor );
-Example 2
-var anchor = document.querySelector( '#bazinga' );
-var toggle = document.querySelector('#toggle');
-var options = { speed: 1000, easing: 'easeOutCubic' };
-smoothScroll.animateScroll( anchor, toggle, options );
-Example 3
-// You can optionally pass in a y-position to scroll to as an integer
-smoothScroll.animateScroll( 750 );
-destroy()
-Destroy the current smoothScroll.init(). This is called automatically during the init function to remove any existing initializations.
smoothScroll.destroy();
-- - -
Fixed Headers
-If you're using a fixed header, Smooth Scroll will automatically offset scroll distances by the header height. Pass in a valid CSS selector for your fixed header as an option to the init.
If you have multiple fixed headers, pass in the last one in the markup.
-<nav data-scroll-header>
- ...
-</nav>
-...
-<script>
- smoothScroll.init({
- selectorHeader: '[data-scroll-header]'
- });
-</script>
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/support.html b/docs/support.html
deleted file mode 100755
index c0cf939..0000000
--- a/docs/support.html
+++ /dev/null
@@ -1,136 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
- -
- - -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Getting Started
-Compiled and production-ready code can be found in the dist directory. The src directory contains development code.
- -
Quick Start
-1. Include Smooth Scroll on your site.
-<script src="dist/js/smooth-scroll.js"></script>
-2. Add the markup to your HTML.
-Turn anchor links into Smooth Scroll links by adding the [data-scroll] data attribute. Give the anchor location an ID just like you normally would.
<a data-scroll href="#bazinga">Anchor Link</a>
-...
-<span id="bazinga">Bazinga!</span>
-3. Initialize Smooth Scroll.
-In the footer of your page, after the content, initialize Smooth Scroll. And that's it, you're done. Nice work!
-<script>
- smoothScroll.init();
-</script>
-- -
Using a Package Manager
-Install Smooth Scroll with your favorite package manager or module bundler directly from NPM.
-npm install smooth-scroll
-- - -
Working with the Source Files
-If you would prefer, you can work with the development code in the src directory using the included Gulp build system. This compiles, lints, and minifies code.
Dependencies
-Make sure these are installed first.
- -Using Gulp
--
-
- In bash/terminal/command line,
cdinto your project directory.
- - Run
npm installto install required files.
- - When it's done installing, run one of the task runners to get going:
-
-
gulpmanually compiles files.
-gulp watchautomatically compiles files when changes are made and applies changes using LiveReload.
-
-
Compiled and production-ready code can be found in the dist directory. The src directory contains development code.
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/gulpfile.js b/gulpfile.js
index 0090d12..0b20e1e 100755
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -1,98 +1,44 @@
/**
* Settings
+ * Turn on/off build features
*/
var settings = {
- scripts: true, // Turn on/off script tasks
- styles: false, // Turn on/off style tasks
- svgs: false, // Turn on/off SVG tasks
- images: false, // Turn on/off image tasks
- static: false, // Turn on/off static file copying
- docs: true, // Turn on/off documentation generation
- deploy: true, // Turn on/off all deployment tasks
- cacheBust: false, // Turn on/off cache busting (adds a version number to minified files)
- gitAdd: true, // Turn on/off git add -A
- gitCommit: true, // Turn on/off git commit -a
- gitPush: true, // Turn on/off push to git
- gitTag: true, // Turn on/off add a git tag
- npm: false // Turn on/off push to NPM
+ clean: true,
+ scripts: true,
+ polyfills: true,
+ styles: false,
+ svgs: false,
+ copy: true,
+ reload: true
};
-/**
- * Gulp Packages
- */
-
-// General
-var gulp = require('gulp');
-var fs = require('fs');
-var del = require('del');
-var exec = require('child_process').exec;
-var lazypipe = require('lazypipe');
-var plumber = require('gulp-plumber');
-var flatten = require('gulp-flatten');
-var tap = require('gulp-tap');
-var rename = require('gulp-rename');
-var header = require('gulp-header');
-var footer = require('gulp-footer');
-var watch = require('gulp-watch');
-var livereload = require('gulp-livereload');
-var package = require('./package.json');
-
-// Scripts
-var jshint = settings.scripts ? require('gulp-jshint') : null;
-var stylish = settings.scripts ? require('jshint-stylish') : null;
-var concat = settings.scripts ? require('gulp-concat') : null;
-var uglify = settings.scripts ? require('gulp-uglify') : null;
-var optimizejs = settings.scripts ? require('gulp-optimize-js') : null;
-
-// Styles
-var sass = settings.styles ? require('gulp-sass') : null;
-var prefix = settings.styles ? require('gulp-autoprefixer') : null;
-var minify = settings.styles ? require('gulp-cssnano') : null;
-
-// SVGs
-var svgmin = settings.svgs ? require('gulp-svgmin') : null;
-var svgstore = settings.svgs ? require('gulp-svgstore') : null;
-
-// Docs
-var markdown = settings.docs ? require('gulp-markdown') : null;
-var fileinclude = settings.docs ? require('gulp-file-include') : null;
-
-
/**
* Paths to project folders
*/
var paths = {
- input: 'src/**/*',
+ input: 'src/',
output: 'dist/',
scripts: {
input: 'src/js/*',
- output: 'dist/js/'
+ polyfills: '.polyfill.js',
+ output: 'dist/'
},
styles: {
input: 'src/sass/**/*.{scss,sass}',
output: 'dist/css/'
},
svgs: {
- input: 'src/svg/*',
+ input: 'src/svg/*.svg',
output: 'dist/svg/'
},
- images: {
- input: 'src/img/*',
- output: 'dist/img/'
+ copy: {
+ input: 'src/copy/*',
+ output: './'
},
- static: {
- input: 'src/static/*',
- output: 'dist/'
- },
- docs: {
- input: 'src/docs/*.{html,md,markdown}',
- output: 'docs/',
- templates: 'src/docs/_templates/',
- assets: 'src/docs/assets/**'
- }
+ reload: './'
};
@@ -101,14 +47,15 @@ var paths = {
*/
var banner = {
- full :
+ full:
'/*!\n' +
- ' * <%= package.name %> v<%= package.version %>: <%= package.description %>\n' +
+ ' * <%= package.name %> v<%= package.version %>\n' +
+ ' * <%= package.description %>\n' +
' * (c) ' + new Date().getFullYear() + ' <%= package.author.name %>\n' +
' * <%= package.license %> License\n' +
' * <%= package.repository.url %>\n' +
' */\n\n',
- min :
+ min:
'/*!' +
' <%= package.name %> v<%= package.version %>' +
' | (c) ' + new Date().getFullYear() + ' <%= package.author.name %>' +
@@ -118,275 +65,251 @@ var banner = {
};
+/**
+ * Gulp Packages
+ */
+
+// General
+var {gulp, src, dest, watch, series, parallel} = require('gulp');
+var del = require('del');
+var flatmap = require('gulp-flatmap');
+var lazypipe = require('lazypipe');
+var rename = require('gulp-rename');
+var header = require('gulp-header');
+var package = require('./package.json');
+
+// Scripts
+var jshint = require('gulp-jshint');
+var stylish = require('jshint-stylish');
+var concat = require('gulp-concat');
+var uglify = require('gulp-uglify');
+var optimizejs = require('gulp-optimize-js');
+
+// Styles
+var sass = require('gulp-sass');
+var prefix = require('gulp-autoprefixer');
+var minify = require('gulp-cssnano');
+
+// SVGs
+var svgmin = require('gulp-svgmin');
+
+// BrowserSync
+var browserSync = require('browser-sync');
+
+
/**
* Gulp Tasks
*/
+// Remove pre-existing content from output folders
+var cleanDist = function (done) {
+
+ // Make sure this feature is activated before running
+ if (!settings.clean) return done();
+
+ // Clean the dist folder
+ del.sync([
+ paths.output
+ ]);
+
+ // Signal completion
+ return done();
+
+};
+
+// Repeated JavaScript tasks
+var jsTasks = lazypipe()
+ .pipe(header, banner.full, {package: package})
+ .pipe(optimizejs)
+ .pipe(dest, paths.scripts.output)
+ .pipe(rename, {suffix: '.min'})
+ .pipe(uglify)
+ .pipe(optimizejs)
+ .pipe(header, banner.min, {package: package})
+ .pipe(dest, paths.scripts.output);
+
// Lint, minify, and concatenate scripts
-gulp.task('build:scripts', ['clean:dist'], function() {
- if ( !settings.scripts ) return;
-
- var fileVersion = settings.cacheBust ? '.' + package.version : '';
-
- var jsTasks = lazypipe()
- .pipe(header, banner.full, { package : package })
- .pipe(optimizejs)
- .pipe(gulp.dest, paths.scripts.output)
- .pipe(rename, { suffix: '.min' + fileVersion })
- .pipe(uglify)
- .pipe(optimizejs)
- .pipe(header, banner.min, { package : package })
- .pipe(gulp.dest, paths.scripts.output);
-
- return gulp.src(paths.scripts.input)
- .pipe(plumber())
- .pipe(tap(function (file, t) {
- if ( file.isDirectory() ) {
- var name = file.relative + '.js';
- return gulp.src(file.path + '/*.js')
- .pipe(concat(name))
+var buildScripts = function (done) {
+
+ // Make sure this feature is activated before running
+ if (!settings.scripts) return done();
+
+ // Run tasks on script files
+ src(paths.scripts.input)
+ .pipe(flatmap(function(stream, file) {
+
+ // If the file is a directory
+ if (file.isDirectory()) {
+
+ // Setup a suffix variable
+ var suffix = '';
+
+ // If separate polyfill files enabled
+ if (settings.polyfills) {
+
+ // Update the suffix
+ suffix = '.polyfills';
+
+ // Grab files that aren't polyfills, concatenate them, and process them
+ src([file.path + '/*.js', '!' + file.path + '/*' + paths.scripts.polyfills])
+ .pipe(concat(file.relative + '.js'))
+ .pipe(jsTasks());
+
+ }
+
+ // Grab all files and concatenate them
+ // If separate polyfills enabled, this will have .polyfills in the filename
+ src(file.path + '/*.js')
+ .pipe(concat(file.relative + suffix + '.js'))
.pipe(jsTasks());
+
+ return stream;
+
}
- }))
- .pipe(jsTasks());
-});
+
+ // Otherwise, process the file
+ return stream.pipe(jsTasks());
+
+ }));
+
+ // Signal completion
+ done();
+
+};
+
+// Lint scripts
+var lintScripts = function (done) {
+
+ // Make sure this feature is activated before running
+ if (!settings.scripts) return done();
+
+ // Lint scripts
+ src(paths.scripts.input)
+ .pipe(jshint())
+ .pipe(jshint.reporter('jshint-stylish'));
+
+ // Signal completion
+ done();
+
+};
// Process, lint, and minify Sass files
-gulp.task('build:styles', ['clean:dist'], function() {
- if ( !settings.styles ) return;
+var buildStyles = function (done) {
- var fileVersion = settings.cacheBust ? '.' + package.version : '';
+ // Make sure this feature is activated before running
+ if (!settings.styles) return done();
- return gulp.src(paths.styles.input)
- .pipe(plumber())
+ // Run tasks on all Sass files
+ src(paths.styles.input)
.pipe(sass({
outputStyle: 'expanded',
sourceComments: true
}))
- .pipe(flatten())
.pipe(prefix({
- browsers: ['last 2 version', '> 1%'],
+ browsers: ['last 2 version', '> 0.25%'],
cascade: true,
remove: true
}))
.pipe(header(banner.full, { package : package }))
- .pipe(gulp.dest(paths.styles.output))
- .pipe(rename({ suffix: '.min' + fileVersion }))
+ .pipe(dest(paths.styles.output))
+ .pipe(rename({suffix: '.min'}))
.pipe(minify({
discardComments: {
removeAll: true
}
}))
.pipe(header(banner.min, { package : package }))
- .pipe(gulp.dest(paths.styles.output));
-});
-
-// Generate SVG sprites
-gulp.task('build:svgs', ['clean:dist'], function () {
- if ( !settings.svgs ) return;
-
- return gulp.src(paths.svgs.input)
- .pipe(plumber())
- .pipe(tap(function (file, t) {
- if ( file.isDirectory() ) {
- var name = file.relative + '.svg';
- return gulp.src(file.path + '/*.svg')
- .pipe(svgmin())
- .pipe(svgstore({
- fileName: name,
- prefix: 'icon-',
- inlineSvg: true
- }))
- .pipe(gulp.dest(paths.svgs.output));
- }
- }))
- .pipe(svgmin())
- .pipe(gulp.dest(paths.svgs.output));
-});
+ .pipe(dest(paths.styles.output));
-// Copy image files into output folder
-gulp.task('build:images', ['clean:dist'], function() {
- if ( !settings.images ) return;
+ // Signal completion
+ done();
- return gulp.src(paths.images.input)
- .pipe(plumber())
- .pipe(gulp.dest(paths.images.output));
-});
+};
-// Copy static files into output folder
-gulp.task('build:static', ['clean:dist'], function() {
- if ( !settings.static ) return;
+// Optimize SVG files
+var buildSVGs = function (done) {
- return gulp.src(paths.static.input)
- .pipe(plumber())
- .pipe(gulp.dest(paths.static.output));
-});
+ // Make sure this feature is activated before running
+ if (!settings.svgs) return done();
-// Lint scripts
-gulp.task('lint:scripts', function () {
- if ( !settings.scripts ) return;
-
- return gulp.src(paths.scripts.input)
- .pipe(plumber())
- .pipe(jshint())
- .pipe(jshint.reporter('jshint-stylish'));
-});
+ // Optimize SVG files
+ src(paths.svgs.input)
+ .pipe(svgmin())
+ .pipe(dest(paths.svgs.output));
-// Remove pre-existing content from output folders
-gulp.task('clean:dist', function () {
- del.sync([
- paths.output
- ]);
-});
+ // Signal completion
+ done();
-// Generate documentation
-gulp.task('build:docs', ['compile', 'clean:docs'], function() {
- if ( !settings.docs ) return;
+};
- return gulp.src(paths.docs.input)
- .pipe(plumber())
- .pipe(fileinclude({
- prefix: '@@',
- basepath: '@file'
- }))
- .pipe(tap(function (file, t) {
- if ( /\.md|\.markdown/.test(file.path) ) {
- return t.through(markdown);
- }
- }))
- .pipe(header(fs.readFileSync(paths.docs.templates + '/_header.html', 'utf8')))
- .pipe(footer(fs.readFileSync(paths.docs.templates + '/_footer.html', 'utf8')))
- .pipe(gulp.dest(paths.docs.output));
-});
-
-// Copy distribution files to docs
-gulp.task('copy:dist', ['compile', 'clean:docs'], function() {
- if ( !settings.docs ) return;
-
- return gulp.src(paths.output + '/**')
- .pipe(plumber())
- .pipe(gulp.dest(paths.docs.output + '/dist'));
-});
-
-// Copy documentation assets to docs
-gulp.task('copy:assets', ['clean:docs'], function() {
- if ( !settings.docs ) return;
-
- return gulp.src(paths.docs.assets)
- .pipe(plumber())
- .pipe(gulp.dest(paths.docs.output + '/assets'));
-});
-
-// Remove prexisting content from docs folder
-gulp.task('clean:docs', function () {
- if ( !settings.docs ) return;
- return del.sync(paths.docs.output);
-});
-
-// Spin up livereload server and listen for file changes
-gulp.task('listen', function () {
- livereload.listen();
- gulp.watch(paths.input).on('change', function(file) {
- gulp.start('default');
- gulp.start('refresh');
- });
-});
+// Copy static files into output folder
+var copyFiles = function (done) {
-// Run livereload after file change
-gulp.task('refresh', ['compile', 'docs'], function () {
- livereload.changed();
-});
+ // Make sure this feature is activated before running
+ if (!settings.copy) return done();
-// Add to Git
-gulp.task('deploy:gitAdd', ['compile', 'docs'], function () {
- if ( !settings.deploy || !settings.gitAdd ) return;
+ // Copy static files
+ src(paths.copy.input)
+ .pipe(dest(paths.copy.output));
- exec('git add -A', function (err, stdout, stderr) {
- console.log(stdout);
- console.log(stderr);
- });
-});
+ // Signal completion
+ done();
-// Commit to Git
-gulp.task('deploy:gitCommit', ['compile', 'docs', 'deploy:gitAdd'], function () {
- if ( !settings.deploy || !settings.gitCommit ) return;
+};
- exec('git commit -a', function (err, stdout, stderr) {
- console.log(stdout);
- console.log(stderr);
- });
-});
+// Watch for changes to the src directory
+var startServer = function (done) {
-// Push to Git
-gulp.task('deploy:gitPush', ['compile', 'docs', 'deploy:gitAdd', 'deploy:gitCommit'], function () {
- if ( !settings.deploy || !settings.gitPush ) return;
+ // Make sure this feature is activated before running
+ if (!settings.reload) return done();
- exec('BRANCH=$(git symbolic-ref -q HEAD); BRANCH=${BRANCH##refs/heads/}; BRANCH=${BRANCH:-HEAD}; git push origin $BRANCH', function (err, stdout, stderr) {
- console.log(stdout);
- console.log(stderr);
+ // Initialize BrowserSync
+ browserSync.init({
+ server: {
+ baseDir: paths.reload
+ }
});
-});
-// Tag on Git
-gulp.task('deploy:gitTag', ['compile', 'docs', 'deploy:gitAdd', 'deploy:gitCommit', 'deploy:gitPush'], function () {
- if ( !settings.deploy || !settings.gitTag ) return;
+ // Signal completion
+ done();
- exec('git tag -a v' + package.version + '; git push origin v' + package.version, function (err, stdout, stderr) {
- console.log(stdout);
- console.log(stderr);
- });
-});
+};
-// Push to NPM
-gulp.task('deploy:npm', ['compile', 'docs', 'deploy:gitAdd', 'deploy:gitCommit', 'deploy:gitPush', 'deploy:gitTag'], function () {
- if ( !settings.deploy || !settings.npm ) return;
+// Reload the browser when files change
+var reloadBrowser = function (done) {
+ if (!settings.reload) return done();
+ browserSync.reload();
+ done();
+};
- exec('npm publish', function (err, stdout, stderr) {
- console.log(stdout);
- console.log(stderr);
- });
-});
+// Watch for changes
+var watchSource = function (done) {
+ watch(paths.input, series(exports.default, reloadBrowser));
+ done();
+};
/**
- * Task Runners
+ * Export Tasks
*/
-// Compile files
-gulp.task('compile', [
- 'lint:scripts',
- 'clean:dist',
- 'build:scripts',
- 'build:styles',
- 'build:images',
- 'build:static',
- 'build:svgs'
-]);
-
-// Generate documentation
-gulp.task('docs', [
- 'clean:docs',
- 'build:docs',
- 'copy:dist',
- 'copy:assets'
-]);
-
-// Compile files and generate docs (default)
-gulp.task('default', [
- 'compile',
- 'docs'
-]);
-
-// Compile files and generate docs when something changes
-gulp.task('watch', [
- 'listen',
- 'default'
-]);
-
-gulp.task('deploy', [
- 'deploy:gitAdd',
- 'deploy:gitCommit',
- 'deploy:gitPush',
- 'deploy:gitTag',
- 'deploy:npm'
-]);
\ No newline at end of file
+// Default task
+// gulp
+exports.default = series(
+ cleanDist,
+ parallel(
+ buildScripts,
+ lintScripts,
+ buildStyles,
+ buildSVGs,
+ copyFiles
+ )
+);
+
+// Watch and reload
+// gulp watch
+exports.watch = series(
+ exports.default,
+ startServer,
+ watchSource
+);
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100755
index 0000000..a10fdc9
--- /dev/null
+++ b/index.html
@@ -0,0 +1,149 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
- - -
- - -
- - -
- - -
-
-
-
- Smooth Scroll
-
-
- GPLv3/Commercial License
- Version 11
-
Want to learn how to write your own vanilla JS plugins? Get my free daily developer tips and level-up as a web developer. 🚀
-Support
-If you're having issues with Smooth Scroll, there are a few ways to get help.
-- - -
Community Support
-You can ask questions and get help from a community of developers on GitHub Issues.
-Before posting, do a search to make sure your issue or questions hasn't already been reported or discussed. If no matching issue exists, go ahead and create one. Please be sure to include all of the following:
--
-
- A clear, descriptive title (ie. "A bug" is not a good title). -
- A reduced test case.
-
-
- Clearly demonstrate the bug or issue. -
- Include the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug. -
- A link to your production site is not a reduced test case. -
- - The browser and OS that you're using. -
Duplicates and issues without a reduced test case may be closed without comment.
-- - -
Premium Support
-Premium Support gives your direct access to me by email to answer any specific questions or issues you have.
- -- - -
Custom Support
-If you want to customize Smooth Scroll to better meet your needs, I can help. Send me an email at chris@gomakethings.com with the details.
-- - -
Feature Requests
-Please post feature requests on GitHub Issues and clearly mark it as a feature request. Provide as much detail as you can.
-If there's a feature listed there already that you'd like to see incorporated into the plugin, add your support.
- - - -
+ Linear
+ Linear (no other options)
+
+ Ease-In
+ Quad
+ Cubic
+ Quart
+ Quint
+
+ Ease-In-Out
+ Quad
+ Cubic
+ Quart
+ Quint
+
+ Ease-Out
+ Quad
+ Cubic
+ Quart
+ Quint
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ Non-ASCII Characters
+ ä¸ć–‡
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ ä¸ć–‡ + More Special Characters +
+ +
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
myymälä
+ +
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+ .
.
.
.
.
.
.
.
.
.
.
.
.
+
.
.
.
.
.