Smooth Scroll Plugin
Download
Using npm:
-1 npm install jquery-smooth-scroll
+1 npm install jquery-smooth-scroll
The old-fashioned way:
Go to the following URL in your browser and copy/paste the code into your own file:
@@ -98,7 +98,7 @@
$.fn.smoothScroll
Options
The following options, shown with their default values, are available for both $.fn.smoothScroll and $.smoothScroll:
-12345678910111213141516171819202122232425262728293031323334 { offset: 0, // one of 'top' or 'left' direction: 'top', // only use if you want to override default behavior scrollTarget: null, // string to use as selector for event delegation (Requires jQuery >=1.4.2) delegateSelector: null, // fn(opts) function to be called before scrolling occurs. // `this` is the element(s) being scrolled beforeScroll: function() {}, // fn(opts) function to be called after scrolling occurs. // `this` is the triggering element afterScroll: function() {}, easing: 'swing', // speed can be a number or 'auto' // if 'auto', the speed will be calculated based on the formula: // (current scroll position - target scroll position) / autoCoeffic speed: 400, // autoCoefficent: Only used when speed set to "auto". // The higher this number, the faster the scroll speed autoCoefficient: 2, // $.fn.smoothScroll only: whether to prevent the default click action preventDefault: true }
+12345678910111213141516171819202122232425262728293031323334 { offset: 0, // one of 'top' or 'left' direction: 'top', // only use if you want to override default behavior scrollTarget: null, // string to use as selector for event delegation (Requires jQuery >=1.4.2) delegateSelector: null, // fn(opts) function to be called before scrolling occurs. // `this` is the element(s) being scrolled beforeScroll: function() {}, // fn(opts) function to be called after scrolling occurs. // `this` is the triggering element afterScroll: function() {}, easing: 'swing', // speed can be a number or 'auto' // if 'auto', the speed will be calculated based on the formula: // (current scroll position - target scroll position) / autoCoeffic speed: 400, // autoCoefficent: Only used when speed set to "auto". // The higher this number, the faster the scroll speed autoCoefficient: 2, // $.fn.smoothScroll only: whether to prevent the default click action preventDefault: true }
The options object for $.fn.smoothScroll can take two additional properties:
exclude and excludeWithin. The value for both of these is an array of
@@ -115,7 +115,7 @@
$.smoothScroll
document.body)
Doesn't automatically fire, so you need to bind it to some other user
interaction. For example:
-1234567 $('button.scrollsomething').on('click', function() { $.smoothScroll({ scrollElement: $('div.scrollme'), scrollTarget: '#findme' }); return false;});
+1234567 $('button.scrollsomething').on('click', function() { $.smoothScroll({ scrollElement: $('div.scrollme'), scrollTarget: '#findme' }); return false;});
The $.smoothScroll method can take one or two arguments.
@@ -129,7 +129,7 @@ $.smoothScroll
Additional Option
The following option, in addition to those listed for $.fn.smoothScroll above, is available
for $.smoothScroll:
-
12345 { // jQuery set of elements you wish to scroll. // if null (default), $('html, body').firstScrollable() is used. scrollElement: null}
+12345 { // jQuery set of elements you wish to scroll. // if null (default), $('html, body').firstScrollable() is used. scrollElement: null}
$.fn.scrollable
@@ -148,6 +148,22 @@ $.fn.firstScrollable
$('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:
+12345 $('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:
+12345678 // 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:
+12345 $('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:
+12345678 $('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
diff --git a/readme.md b/readme.md
index 38baeb2..07c0976 100644
--- a/readme.md
+++ b/readme.md
@@ -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 `` 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
From bf3b07cb53c15d5f903219f303368ded4546d695 Mon Sep 17 00:00:00 2001
From: Karl Swedberg
Date: Sun, 31 Jul 2016 15:55:28 -0400
Subject: [PATCH 02/38] Documentation and demo updates.
---
.jscsrc | 1 -
demo/bbq.html | 4 ++++
demo/hashchange.html | 28 ++++++++++++++++++----------
readme.md | 10 ++++++----
src/jquery.smooth-scroll.js | 7 +++++++
5 files changed, 35 insertions(+), 15 deletions(-)
diff --git a/.jscsrc b/.jscsrc
index 2fb84d0..d458b8c 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -1,5 +1,4 @@
{
- "esnext": true,
"requireCurlyBraces": [
"if",
"else",
diff --git a/demo/bbq.html b/demo/bbq.html
index af2bb2c..1af2fac 100644
--- a/demo/bbq.html
+++ b/demo/bbq.html
@@ -45,6 +45,10 @@ Smooth Scroll jQuery Plugin with Back Button Support
+