Added ability to manually scroll up or down.

d4nyll · d4nyll · commit 46b71922bf99 · 2015-12-24T22:33:48.000+08:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # smartscroll
 
-smartscroll is a tiny (1420b minfied + gzipped) jQuery plugin that has these *independent* features:
+smartscroll is a tiny (1473b minfied + gzipped) jQuery plugin that has these *independent* features:
 
 1. Section scrolling - Scrolljacking
 2. Auto-hash - Updates the URL hash based on current position on page
@@ -95,6 +95,15 @@ Smartscroll has a soft dependency on [EventEmitter](https://github.com/Olical/Ev
       eventEmitter: ee
     });
 
+### Manual Scroll
+
+You can manually scroll up or scroll down.
+
+When you first initiate smartscroll with `$.smartscroll()`, it returns an  object. In that object is the `scroll` function, which is called with a single parameter. If the parameter is truthy, it will scroll down, otherwise, it will scroll up.
+
+    var smartscroll = $.smartscroll();
+    smartscroll.scroll(1);
+
 ### Architecture
 
 Currently, there are two features of smartscroll, and this is how it's implemented:
diff --git a/bower.json b/bower.json
@@ -4,7 +4,7 @@
     "smartscroll.js",
     "sass/smartscroll.scss"
   ],
-  "version": "2.1.7",
+  "version": "2.2.0",
   "homepage": "https://github.com/d4nyll/smartscroll",
   "repository": {
     "type": "git",
diff --git a/examples/auto-hash/index.html b/examples/auto-hash/index.html
@@ -12,7 +12,7 @@
 		<div class="section" data-hash="a">
 			<div>
 				<h1>smartscroll - Auto-Hash</h1>
-				<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+				<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 				<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 				<p>Try out other examples!</p>
 				<ul>
diff --git a/examples/different-heights-hybrid-scroll/index.html b/examples/different-heights-hybrid-scroll/index.html
@@ -11,7 +11,7 @@
 	<div class="header">
 		<div>
 			<h1>smartscroll - Different Heights &amp; Hybrid Scroll</h1>
-			<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+			<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 			<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 			<p>Try out other examples!</p>
 			<ul>
diff --git a/examples/different-heights-inner-section-scroll/index.html b/examples/different-heights-inner-section-scroll/index.html
@@ -12,7 +12,7 @@
 		<div class="section" data-hash="a">
 			<div>
 				<h1>smartscroll - Different Heights</h1>
-				<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+				<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 				<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 				<p>Try out other examples!</p>
 				<ul>
diff --git a/examples/different-heights/index.html b/examples/different-heights/index.html
@@ -12,7 +12,7 @@
 		<div class="section" data-hash="a">
 			<div>
 				<h1>smartscroll - Different Heights</h1>
-				<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+				<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 				<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 				<p>Try out other examples!</p>
 				<ul>
diff --git a/examples/hybrid-scroll/index.html b/examples/hybrid-scroll/index.html
@@ -11,7 +11,7 @@
 	<div class="header">
 		<div>
 			<h1>smartscroll - Hybrid Scroll</h1>
-			<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+			<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 			<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 			<p>Try out other examples!</p>
 			<ul>
diff --git a/examples/index.html b/examples/index.html
@@ -11,7 +11,7 @@
 	<div class="header">
 		<div>
 			<h1>smartscroll</h1>
-			<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+			<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 			<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 			<p>Try out other examples!</p>
 			<ul>
@@ -21,7 +21,7 @@ <h1>smartscroll</h1>
 				<li><a href="http://d4nyll.github.io/smartscroll/hybrid-scroll/">Hybrid Scroll</a></li>
 				<li><a href="http://d4nyll.github.io/smartscroll/auto-hash/">Auto-Hash</a></li>
 				<li><a href="http://d4nyll.github.io/smartscroll/keep-history/">Keep History</a></li>
-				<li><a href="http://d4nyll.github.io/smartscroll/responsive/">Keep History</a></li>
+				<li><a href="http://d4nyll.github.io/smartscroll/responsive/">Responsive</a></li>
 			</ul>
 		</div>
 	</div>
@@ -93,12 +93,13 @@ <h1>Responsive</h1>
 		}
 		ee.addListener('scrollStart', scrollStartListener);
 		ee.addListener('scrollEnd', scrollEndListener);
-		$.smartscroll({
+		var smartscroll = $.smartscroll({
 			sectionWrapperSelector: ".section-wrapper",
 			sectionClass: "section",
 			headerHash: "welcome",
 			eventEmitter: ee
 		});
+		console.log(smartscroll);
 	</script>
 </body>
 </html>
diff --git a/examples/keep-history/index.html b/examples/keep-history/index.html
@@ -12,7 +12,7 @@
 		<div class="section" data-hash="a">
 			<div>
 				<h1>smartscroll - Keep History</h1>
-				<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+				<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 				<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 				<p>Try out other examples!</p>
 				<ul>
diff --git a/examples/permalink/index.html b/examples/permalink/index.html
@@ -12,7 +12,7 @@
 		<div class="section" data-hash="a">
 			<div>
 				<h1>smartscroll - Permalink</h1>
-				<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+				<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 				<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 				<p>Try out other examples!</p>
 				<ul>
diff --git a/examples/responsive/index.html b/examples/responsive/index.html
@@ -11,7 +11,7 @@
 	<div class="header">
 		<div>
 			<h1>smartscroll - Responsive</h1>
-			<p>A tiny (1420b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
+			<p>A tiny (1473b minfied + gzipped) jQuery plugin for scrolljacking and auto-hashing</p>
 			<p>See it on <a href="https://github.com/d4nyll/smartscroll" target="_blank">GitHub</a>, or see some <a href="http://blog.danyll.com/smartscroll-jquery-scrolljacking-plugin/" target="_blank">comparisons</a></p>
 			<p>Try out other examples!</p>
 			<ul>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "smartscroll",
-  "version": "2.1.7",
+  "version": "2.2.0",
   "description": "Scrolljacking jQuery plugin",
   "main": "smartscroll.js",
   "directories": {
diff --git a/smartscroll.js b/smartscroll.js
@@ -84,6 +84,7 @@
 		var isScrolling = false;
 
 		var sections = [];
+
 		var sectionWrapperTop;
 		var sectionWrapperBottom;
 
@@ -107,12 +108,29 @@
 				scrollTop: pixel
 			}, speed, function() {
 				isScrolling = false;
-				if(options.eventEmitter) {
+				if (options.eventEmitter) {
 					options.eventEmitter.emitEvent("scrollEnd");
 				}
 			});
 		};
 
+		// Make this public
+		this.scroll = function (down) {
+			if(sections) {
+				var windowTop = getWindowTop();
+				for (var i = 0; i < sections.length; i++ ) {
+					if (windowTop < sections[i]) {
+						if(!!down) {
+							scrollToPixel(sections[i], 700);
+						} else {
+							scrollToPixel(sections[i - 1] - $(window).height(), 700);
+						}
+						return false;
+					}
+				}
+			}
+		}
+
 		// Update the values for `sections`
 		var calculateSectionBottoms = function () {
 			var tmpSections = [];
@@ -360,6 +378,7 @@
 			}
 			bindScroll();
 		}
+		return this;
 	}
 
 	// Set default options
diff --git a/smartscroll.min.js b/smartscroll.min.js
