Merge branch 'master' into gh-pages

Author: kswedberg

Gruntfile.js

@@ -1,7 +1,7 @@
 /*global module:false*/
 
 module.exports = function(grunt) {
-
+  var pkg = grunt.file.readJSON('package.json');
   var marked = require('marked');
   var hl = require('node-syntaxhighlighter');
 
@@ -18,7 +18,7 @@ module.exports = function(grunt) {
   // Project configuration.
   grunt.initConfig({
     pluginName: 'smooth-scroll',
-    pkg: grunt.file.readJSON('package.json'),
+    pkg: pkg,
     meta: {
       banner: '/*!<%= "\\n" %>' +
           ' * <%= pkg.title %> - v<%= pkg.version %> - ' +
@@ -103,21 +103,22 @@ module.exports = function(grunt) {
       }
     },
     version: {
-
-      files: {
-        src: [
-          'package.json',
-          'src/jquery.<%= pluginName %>.js',
-          'jquery.<%= pluginName %>.js'
-        ]
+      src: {
+        src: ['src/jquery.<%= pluginName %>.js']
       },
-      banner: {
-        src: ['jquery.<%= pluginName %>.js'],
+      banners: {
+        pkg: pkg,
+        src: [
+          'jquery.<%= pluginName %>.js',
+          'jquery.<%= pluginName %>.min.js'
+        ],
         options: {
           prefix: '- v'
         }
       },
-
+      package: {
+        src: ['package.json']
+      },
     }
   });
 
@@ -130,11 +131,34 @@ module.exports = function(grunt) {
     grunt.file.write('index.html', head + doc + foot);
   });
 
+  grunt.registerTask('updateBower', 'Update bower.json to match package.json', function() {
+    var pkg = require('./package.json');
+    var props = ['name', 'main', 'homepage', 'repository', 'dependencies', 'keywords', 'license'];
+    var json = {
+      description: 'Easy implementation of smooth scrolling for same-page links'
+    };
+
+    props.forEach(function(item) {
+      if (pkg[item]) {
+        json[item] = pkg[item];
+      }
+    });
+
+    json.authors = [pkg.author];
+    json.moduleType = ['amd', 'node'];
+    json.ignore = ['demo/', 'lib/', 'src/', 'test/', '**/.*', 'Gruntfile.js', 'package.json'];
+
+    grunt.file.write('bower.json', JSON.stringify(json, null, 2));
+  });
+
   grunt.registerTask('lint', ['jshint', 'jscs']);
   grunt.registerTask('build', ['lint', 'concat', 'version', 'uglify', 'docs']);
-  grunt.registerTask('patch', ['lint', 'concat', 'version::patch', 'uglify']);
   grunt.registerTask('default', ['build']);
 
+  ['patch', 'minor', 'major'].forEach(function(release) {
+    grunt.registerTask(release, ['lint', 'version:src:' + release, 'concat', 'uglify', 'version:banners:' + release, 'version:package:' + release]);
+  });
+
   grunt.loadNpmTasks('grunt-jscs');
   grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-uglify');

bower.json

@@ -0,0 +1,40 @@
+{
+  "description": "Easy implementation of smooth scrolling for same-page links",
+  "name": "jquery-smooth-scroll",
+  "main": "jquery.smooth-scroll.js",
+  "homepage": "https://github.com/kswedberg/jquery-smooth-scroll",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kswedberg/jquery-smooth-scroll"
+  },
+  "dependencies": {
+    "jquery": ">=1.4.2"
+  },
+  "keywords": [
+    "jQuery",
+    "jquery-plugin",
+    "scroll",
+    "animation"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Karl Swedberg",
+      "email": "kswedberg@gmail.com",
+      "url": "http://www.learningjquery.com/"
+    }
+  ],
+  "moduleType": [
+    "amd",
+    "node"
+  ],
+  "ignore": [
+    "demo/",
+    "lib/",
+    "src/",
+    "test/",
+    "**/.*",
+    "Gruntfile.js",
+    "package.json"
+  ]
+}

demo/index.html

@@ -83,6 +83,7 @@
       <li><a href="#p3">p3</a></li>
       <li><a href="#p4">p4</a></li>
       <li><a href="#p5">p5</a></li>
+      <li><a href="#foo">link to nowhere</a></li>
       <li><a href="bbq.html#p5">bbq.html#p5</a></li>
     </ul>
     <p><a href="bbq.html">Try it with jQuery BBQ hashchange support</a></p>

index.html

@@ -1,5 +1,5 @@
 /*!
- * jQuery Smooth Scroll - v1.6.2 - 2016-01-16
+ * jQuery Smooth Scroll - v1.7.2 - 2016-01-23
  * https://github.com/kswedberg/jquery-smooth-scroll
  * Copyright (c) 2016 Karl Swedberg
  * Licensed MIT
@@ -18,7 +18,7 @@
   }
 }(function($) {
 
-  var version = '1.6.2';
+  var version = '1.7.2';
   var optionOverrides = {};
   var defaults = {
     exclude: [],
@@ -167,6 +167,10 @@
         var pathMatch = thisOpts.scrollTarget || (linkPath === locationPath);
         var thisHash = escapeSelector(link.hash);
 
+        if (thisHash && !$(thisHash).length) {
+          include = false;
+        }
+
         if (!thisOpts.scrollTarget && (!hostMatch || !pathMatch || !thisHash)) {
           include = false;
         } else {

jquery.smooth-scroll.js

@@ -1,7 +1,7 @@
 {
   "name": "jquery-smooth-scroll",
   "title": "jQuery Smooth Scroll",
-  "version": "1.6.2",
+  "version": "1.7.2",
   "scripts": {},
   "main": "jquery.smooth-scroll.js",
   "author": {

jquery.smooth-scroll.min.js

@@ -138,6 +138,62 @@ for `$.smoothScroll`:
   `$('html, body').firstScrollable().animate({scrollTop: someNumber},
   someSpeed)`
 
+## Examples
+
+### Smooth scrolling on page load
+
+If you want to scroll to an element when the page loads, use `$.smoothScroll()` in a script at the end of the body or use `$(document).ready()`. To prevent the browser from automatically scrolling to the element on its own, your link on page 1 will need to include a fragment identifier that does _not_ match an element id on page 2. To ensure that users without JavaScript get to the same element, you should modify the link's hash on page 1 with JavaScript. Your script on page 2 will then modify it back to the correct one when you call `$.smoothScroll()`. 
+
+For example, let's say you want to smooth scroll to `<div id="scrolltome"></div>` on page-2.html. For page-1.html, your script might do the following:
+
+```js
+$('a[href="page-2.html#scrolltome"]').attr('href', function() {
+  var hrefParts = this.href.split(/#/);
+  hrefParts[1] = 'smoothScroll' + hrefParts[1];
+  return hrefParts.join('#');
+});
+
+```
+
+Then for page-2.html, your script would do this: 
+
+```js
+// Call $.smoothScroll if location.hash starts with "#smoothScroll"
+var reSmooth = /^#smoothScroll/;
+var id;
+if (reSmooth.test(location.hash)) {
+  // Strip the "#smoothScroll" part off (and put "#" back on the beginning)
+  id = '#' + location.hash.replace(reSmooth, '');
+  $.smoothScroll({scrollTarget: id});
+}
+```
+
+## Focus element after scrolling to it.
+
+Imagine you have a link to a form somewhere on the same page. When the user clicks the link, you want the user to be able to begin interacting with that form. With the smoothScroll plugin, you can use the `afterScroll` callback function. Here is an example that focuses the first input within the form after scrolling to the form:
+
+```js
+$('a.example').smoothScroll({
+  afterScroll: function(options) {
+    $(options.scrollTarget).find('input')[0].focus();
+  }
+});
+
+```
+
+For accessibility reasons, it might make sense to focus any element you scroll to, even if it's not a natively focusable element. To do so, you could add a `tabIndex` attribute to the target element:
+
+```js
+$('a.example').smoothScroll({
+  afterScroll: function(options) {
+    var $tgt = $(options.scrollTarget);
+    $tgt.attr('tabIndex', '0');
+    // Using $tgt[0] allows us to call .focus() on the DOM node itself, not the jQuery collection
+    $tgt[0].focus();
+  }
+});
+```
+
 ## Notes
 
 * To determine where to scroll the page, the `$.fn.smoothScroll` method looks

package.json

@@ -1,5 +1,5 @@
 (function($) {
-  var version = '1.6.2';
+  var version = '1.7.2';
   var optionOverrides = {};
   var defaults = {
     exclude: [],
@@ -148,6 +148,10 @@
         var pathMatch = thisOpts.scrollTarget || (linkPath === locationPath);
         var thisHash = escapeSelector(link.hash);
 
+        if (thisHash && !$(thisHash).length) {
+          include = false;
+        }
+
         if (!thisOpts.scrollTarget && (!hostMatch || !pathMatch || !thisHash)) {
           include = false;
         } else {