Version 1.4.0 compliant with jQuery.scrollTo 2.0

stinkykong · Mar 18, 2015 · 1a55db8 · 1a55db8
1 parent 2dd1e21
commit 1a55db8
Show file tree

Hide file tree

Showing 11 changed files with 69 additions and 73 deletions.
diff --git a/changes.txt → CHANGELOG b/changes.txt → CHANGELOG
@@ -1,3 +1,7 @@
+1.4.0
+[Compat]
+- Updated so it works with jQuery.scrollTo 2.0
+
 1.3.5
 [Fix]
 - Fixed when lazy true, links with 2+ levels of nested elements won't work, now using $().on()

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2007-2014 Ariel Flesler <[email protected]>
+Copyright (c) 2007-2015 Ariel Flesler <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/README.md b/README.md
@@ -11,9 +11,12 @@ bower install jquery.localScroll
 
 If you want the latest stable version, get the latest release from the [releases page](https://github.com/flesler/jquery.localScroll/releases).
 
-### Notes
+### jQuery.scrollTo
+
+This plugin requires [jQuery.scrollTo](http://github.com/flesler/jquery.scrollTo).
+In order to use jQuery.scrollTo 2.0 you need to update jQuery.localScroll to 1.4.0 and above.
 
-* Requires jQuery.scrollTo (http://github.com/flesler/jquery.scrollTo)
+### Notes
 
 * The hash of settings is passed in to jQuery.scrollTo, so, in addition to jQuery.localScroll's settings, you can use any of jQuery.scrollTo's. Check that plugin's documentation for further information.
 

diff --git a/bower.json b/bower.json
@@ -1,14 +1,14 @@
 {
   "name": "jquery.localScroll",
-  "version": "1.3.5",
+  "version": "1.4.0",
   "description": "Animated anchor navigation made easy.",
   "homepage": "https://github.com/flesler/jquery.localScroll",
   "main": [
     "./jquery.localScroll.js"
   ],
   "dependencies": {
     "jquery": ">=1.8",
-    "jquery.scrollTo": ">=1.4.11"
+    "jquery.scrollTo": ">=2.0.0"
   },
   "keywords": [
     "browser",

diff --git a/demo/ajax/index.html b/demo/ajax/index.html
@@ -2,13 +2,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-	<title>jQuery.LocalScroll</title>
+	<title>jQuery.localScroll</title>
 	<meta name="keywords" content="javascript, jquery, plugins, scroll, anchor, to, navigation, scrollTo, smooth, animation, ajax, overflow, element, window, lazy, effect, ariel, flesler, customizable" />
-	<meta name="description" content="AJAX Demo of jQuery.LocalScroll. A jQuery plugin to make anchor navigation work with a smooth animation, made by Ariel Flesler." />
+	<meta name="description" content="AJAX Demo of jQuery.localScroll. A jQuery plugin to make anchor navigation work with a smooth animation, made by Ariel Flesler." />
 	<meta name="robots" content="index,follow" />
 	<link type="text/css" rel="stylesheet" href="../css/ajax-style.css" />
-	<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.1/jquery.min.js"></script>
-	<script type="text/javascript" src="../../jquery.scrollTo-min.js"></script>
+	<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.0/jquery.min.js"></script>
+	<script type="text/javascript" src="../js/jquery.scrollTo.min.js"></script>
 	<script type="text/javascript" src="../../jquery.localScroll.js"></script>
 	<script type="text/javascript">
 		jQuery(function( $ ){
@@ -20,7 +20,7 @@
 				last = null;// Last section
 
 			$sections.click(function(){
-				if( last != this ){ // let's avoid needless requests
+				if (last !== this) { // let's avoid needless requests
 					// I use the extension .ahah for a speicific reason, you use .html or .php or w/e you want.
 					$('#content').html( '<p class="loading">Loading...</p>' ).load( this.hash.slice(1) + '.html', function(){
 						this.scrollLeft = 0;//scroll back to the left
@@ -35,12 +35,12 @@
 
 			/**
 			 * Actual call to jQuery.localScroll.
-			 * Most jQuery.LocalScroll's defaults, belong to jQuery.ScrollTo, check it's demo for an example of each option.
+			 * Most jQuery.localScroll's defaults, belong to jQuery.ScrollTo, check it's demo for an example of each option.
 			 * @see http://flesler.demos.com/jquery/scrollTo/
 			 */
 
 			$('#content').localScroll({// only the links inside that jquery object will be affected
-				lazy true, // This is the KEY setting here, makes the links work even after an Ajax load.
+				lazy: true, // This is the KEY setting here, makes the links work even after an Ajax load.
 				target: '#content', // The element that gets scrolled
 				axis:'x', // Horizontal scrolling
 				duration:500,
@@ -53,7 +53,7 @@
 	</script>
 </head>
 <body>
-	<h1>jQuery.LocalScroll&nbsp;<strong>by Ariel Flesler</strong></h1>
+	<h1>jQuery.localScroll</h1>
 	<h2 class="title">AJAX Demo</h2>
 	<ul id="navigation">
 		<li><a href="#section1">Section 1</a></li>
@@ -68,11 +68,9 @@ <h2 class="title">AJAX Demo</h2>
 	<div id="links">
 		<h3>Links</h3>
 		<ul>
-			<li><a target="_blank" href="http://plugins.jquery.com/project/LocalScroll">Project Page</a></li>
-			<li><a target="_blank" href="http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html">Main blog article</a></li>
-			<li><a target="_blank" href="http://flesler.blogspot.com/search/label/jQuery.LocalScroll">All articles</a></li>
+			<li><a target="_blank" href="https://github.com/flesler/jquery.localScroll">Github</a></li>
+			<li><a target="_blank" href="http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html">Documentation</a></li>
 			<li><a href="../" rel="prev" rev="next" type="text/html">Regular Demo</a></li>
-			<li><a href="http://flesler.webs.com/jQuery.ScrollTo/" type="text/html">jQuery.ScrollTo's Demo</a></li>
 		</ul>
 	</div>
 </body>

diff --git a/demo/index.html b/demo/index.html
@@ -2,9 +2,9 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-	<title>jQuery.LocalScroll</title>
+	<title>jQuery.localScroll</title>
 	<meta name="keywords" content="javascript, jquery, plugins, scroll, anchor, to, navigation, scrollTo, smooth, animation, overflow, element, window, effect, lazy, ariel, flesler, customizable" />
-	<meta name="description" content="Demo of jQuery.LocalScroll. A jQuery plugin to make anchor navigation work with a smooth animation, made by Ariel Flesler." />
+	<meta name="description" content="Demo of jQuery.localScroll. A jQuery plugin to make anchor navigation work with a smooth animation, made by Ariel Flesler." />
 	<meta name="robots" content="index,follow" />
 	<link type="text/css" rel="stylesheet" href="css/style.css" />
 	<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.0/jquery.min.js"></script>
@@ -14,8 +14,8 @@
 		jQuery(function( $ ){
 			/**
 			 * Most jQuery.localScroll's settings, actually belong to jQuery.ScrollTo, check it's demo for an example of each option.
-			 * @see http://flesler.demos.com/jquery/scrollTo/
-			 * You can use EVERY single setting of jQuery.ScrollTo, in the settings hash you send to jQuery.LocalScroll.
+			 * @see http://demos.flesler.com/jquery/scrollTo/
+			 * You can use EVERY single setting of jQuery.ScrollTo, in the settings hash you send to jQuery.localScroll.
 			 */
 
 			// The default axis is 'y', but in this demo, I want to scroll both
@@ -42,7 +42,7 @@
 	</script>
 </head>
 <body>
-	<h1>jQuery.LocalScroll&nbsp;<strong>by Ariel Flesler</strong></h1>
+	<h1>jQuery.localScroll</h1>
 	<h2 class="title">Regular Demo</h2>
 	<ul id="navigation">
 		<li class="sup">
@@ -203,11 +203,10 @@ <h2>Section 5-c</h2>
 	<div id="links">
 		<h3>Links</h3>
 		<ul>
-			<li><a target="_blank" href="http://plugins.jquery.com/project/LocalScroll">Project Page</a></li>
-			<li><a target="_blank" href="http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html">Main blog article</a></li>
-			<li><a target="_blank" href="http://flesler.blogspot.com/search/label/jQuery.LocalScroll">All articles</a></li>
+			<li><a target="_blank" href="https://github.com/flesler/jquery.localScroll">Github</a></li>
+			<li><a target="_blank" href="http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html">Documentation</a></li>
 			<li><a href="ajax/" rev="prev" rel="next" type="text/html">AJAX Demo</a></li>
-			<li><a href="http://flesler.webs.com/jQuery.ScrollTo/" rel="prev" rev="next" type="text/html">jQuery.ScrollTo's Demo</a></li>
+			<li><a href="http://demos.flesler.com/jquery/scrollTo/" rel="prev" rev="next" type="text/html">jQuery.scrollTo's Demo</a></li>
 		</ul>
 	</div>
 </body>

diff --git a/demo/js/jquery.scrollTo.min.js b/demo/js/jquery.scrollTo.min.js
diff --git a/jquery.localScroll.js b/jquery.localScroll.js
@@ -1,10 +1,10 @@
 /*!
  * jQuery.localScroll
- * Copyright (c) 2007-2014 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
+ * Copyright (c) 2007-2015 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
  * Licensed under MIT
  * http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html
  * @author Ariel Flesler
- * @version 1.3.5
+ * @version 1.4.0
  */
  ;(function(plugin) {
     // AMD Support
@@ -60,8 +60,8 @@
 			.end();
 
 		function filter() {// is this a link that points to an anchor and passes a possible filter ? href is checked to avoid a bug in FF.
-			return !!this.href && !!this.hash && this.href.replace(this.hash,'') == URI && (!settings.filter || $(this).is(settings.filter));
-		};
+			return !!this.href && !!this.hash && this.href.replace(this.hash,'') === URI && (!settings.filter || $(this).is(settings.filter));
+		}
 	};
 
 	// Not needed anymore, kept for backwards compatibility
@@ -71,20 +71,19 @@
 		var id = link.hash.slice(1),
 			elem = document.getElementById(id) || document.getElementsByName(id)[0];
 
-		if (!elem)
-			return;
+		if (!elem) return;
 
-		if (e)
-			e.preventDefault();
+		if (e) e.preventDefault();
 
 		var $target = $(settings.target);
 
 		if (settings.lock && $target.is(':animated') ||
 			settings.onBefore && settings.onBefore(e, elem, $target) === false) 
 			return;
 
-		if (settings.stop)
-			$target._scrollable().stop(true); // remove all its animations
+		if (settings.stop) {
+			$target.stop(true); // remove all its animations
+		}
 
 		if (settings.hash) {
 			var attr = elem.id === id ? 'id' : 'name',
@@ -104,7 +103,7 @@
 		$target
 			.scrollTo(elem, settings) // do scroll
 			.trigger('notify.serialScroll',[elem]); // notify serialScroll about this change
-	};
+	}
 
 	// AMD requirement
 	return $localScroll;

diff --git a/jquery.localScroll.min.js b/jquery.localScroll.min.js
diff --git a/localScroll.jquery.json b/localScroll.jquery.json