Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cferdinandi/smooth-scroll
A lightweight script to animate scrolling to anchor links.
https://github.com/cferdinandi/smooth-scroll
anchor-links animate-scrolling javascript javascript-plugin no-dependencies vanilla-js
Last synced: about 2 months ago
JSON representation
A lightweight script to animate scrolling to anchor links.
- Host: GitHub
- URL: https://github.com/cferdinandi/smooth-scroll
- Owner: cferdinandi
- License: mit
- Archived: true
- Created: 2013-01-25T03:15:05.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-27T19:47:01.000Z (over 4 years ago)
- Last Synced: 2024-04-14T08:32:15.477Z (5 months ago)
- Topics: anchor-links, animate-scrolling, javascript, javascript-plugin, no-dependencies, vanilla-js
- Language: JavaScript
- Homepage:
- Size: 725 KB
- Stars: 5,488
- Watchers: 114
- Forks: 864
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE.md
Awesome Lists containing this project
README
**DEPRECATION NOTICE:**
Smooth Scroll is, without a doubt, my most popular and widely used plugin.
But in the time since I created it, a CSS-only method for smooth scrolling has emerged, and now has fantastic browser support. It can do things this plugin can't (like scrolling to anchor links from another page), and addresses bugs and limitations in the plugin that I have never gotten around to fixing.
This plugin has run its course, and the browser now offers a better, more feature rich and resilient solution out-of-the-box.
Learn [how to animate scrolling to anchor links with one line of CSS](https://gomakethings.com/how-to-animate-scrolling-to-anchor-links-with-one-line-of-css/), and [how to prevent anchor links from scrolling behind fixed or sticky headers](https://gomakethings.com/how-to-prevent-anchor-links-from-scrolling-behind-a-sticky-header-with-one-line-of-css/).
Thanks for the years of support!
---
# Smooth Scroll [](https://travis-ci.org/cferdinandi/smooth-scroll)
A lightweight script to animate scrolling to anchor links. Smooth Scroll works great with [Gumshoe](https://github.com/cferdinandi/gumshoe).
**[View the Demo on CodePen →](https://codepen.io/cferdinandi/pen/wQzrdM)**
[Getting Started](#getting-started) | [Scroll Speed](#scroll-speed) | [Easing Options](#easing-options) | [API](#api) | [What's new?](#whats-new) | [Known Issues](#known-issues) | [Browser Compatibility](#browser-compatibility) | [License](#license)
*__Quick aside:__ you might not need this library. There's [a native CSS way to handle smooth scrolling](https://gomakethings.com/smooth-scrolling-links-with-only-css/) that might fit your needs.*
### Want to learn how to write your own vanilla JS plugins? Check out my [Vanilla JS Pocket Guides](https://vanillajsguides.com/) or join the [Vanilla JS Academy](https://vanillajsacademy.com) 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.
### 1. Include Smooth Scroll on your site.
There are two versions of Smooth Scroll: the standalone version, and one that comes preloaded with polyfills for `closest()`, `requestAnimationFrame()`, and `CustomEvent()`, which are only supported in newer browsers.
If you're including your own polyfills or don't want to enable this feature for older browsers, use the standalone version. Otherwise, use the version with polyfills.
**Direct Download**
You can [download the files directly from GitHub](https://github.com/cferdinandi/smooth-scroll/archive/master.zip).
```html
```
**CDN**
You can also use the [jsDelivr CDN](https://cdn.jsdelivr.net/gh/cferdinandi/smooth-scroll/dist/). I recommend linking to a specific version number or version range to prevent major updates from breaking your site. Smooth Scroll uses semantic versioning.
```html
```
**NPM**
You can also use NPM (or your favorite package manager).
```bash
npm install smooth-scroll
```
### 2. Add the markup to your HTML.
No special markup needed—just standard anchor links. Give the anchor location an ID just like you normally would.
```html
Anchor Link
...
Bazinga!
```
***Note:*** *Smooth Scroll does not work with `` style anchors. It requires IDs.*
### 3. Initialize Smooth Scroll.
In the footer of your page, after the content, initialize Smooth Scroll by passing in a selector for the anchor links that should be animated. And that's it, you're done. Nice work!
```html
var scroll = new SmoothScroll('a[href*="#"]');
```
***Note:*** *The `a[href*="#"]` selector will apply Smooth Scroll to all anchor links. You can selectively target links using any other selector(s) you'd like. Smooth Scroll accepts multiple selectors as a comma separated list. Example: `'.js-scroll, [data-scroll], #some-link'`.*
## Scroll Speed
Smooth Scroll allows you to adjust the speed of your animations with the `speed` option.
This a number representing the amount of time in milliseconds that it should take to scroll 1000px. Scroll distances shorter than that will take less time, and scroll distances longer than that will take more time. The default is 300ms.
```js
var scroll = new SmoothScroll('a[href*="#"]', {
speed: 300
});
```
If you want all of your animations to take exactly the same amount of time (the value you set for `speed`), set the `speedAsDuration` option to `true`.
```js
// All animations will take exactly 500ms
var scroll = new SmoothScroll('a[href*="#"]', {
speed: 500,
speedAsDuration: true
});
```
## Easing Options
Smooth Scroll comes with about a dozen common easing patterns. [Here's a demo of the different patterns.](https://codepen.io/cferdinandi/pen/jQMGaB)
**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`
You can also pass in your own custom easing pattern [using the `customEasing` option](#global-settings).
```js
var scroll = new SmoothScroll('a[href*="#"]', {
// Function. Custom easing pattern
// If this is set to anything other than null, will override the easing option above
customEasing: function (time) {
// return
// Example: easeInOut Quad
return time < 0.5 ? 2 * time * time : -1 + (4 - 2 * time) * time;
}
});
```
## API
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.
### Options and Settings
You can pass options and callbacks into Smooth Scroll when instantiating.
```javascript
var scroll = new SmoothScroll('a[href*="#"]', {
// Selectors
ignore: '[data-scroll-ignore]', // Selector for links to ignore (must be a valid CSS selector)
header: null, // Selector for fixed headers (must be a valid CSS selector)
topOnEmptyHash: true, // Scroll to the top of the page for links with href="#"
// Speed & Duration
speed: 500, // Integer. Amount of time in milliseconds it should take to scroll 1000px
speedAsDuration: false, // If true, use speed as the total duration of the scroll animation
durationMax: null, // Integer. The maximum amount of time the scroll animation should take
durationMin: null, // Integer. The minimum amount of time the scroll animation should take
clip: true, // If true, adjust scroll distance to prevent abrupt stops near the bottom of the page
offset: function (anchor, toggle) {
// Integer or Function returning an integer. How far to offset the scrolling anchor location in pixels
// This example is a function, but you could do something as simple as `offset: 25`
// An example returning different values based on whether the clicked link was in the header nav or not
if (toggle.classList.closest('.my-header-nav')) {
return 25;
} else {
return 50;
}
},
// Easing
easing: 'easeInOutCubic', // Easing pattern to use
customEasing: function (time) {
// Function. Custom easing pattern
// If this is set to anything other than null, will override the easing option above
// return
// Example: easeInOut Quad
return time < 0.5 ? 2 * time * time : -1 + (4 - 2 * time) * time;
},
// History
updateURL: true, // Update the URL on scroll
popstate: true, // Animate scrolling with the forward/backward browser buttons (requires updateURL to be true)
// Custom Events
emitEvents: true // Emit custom events
});
```
### Custom Events
Smooth Scroll emits three custom events:
- `scrollStart` is emitted when the scrolling animation starts.
- `scrollStop` is emitted when the scrolling animation stops.
- `scrollCancel` is emitted if the scrolling animation is canceled.
All three events are emitted on the `document` element and bubble up. You can listen for them with the `addEventListener()` method. The `event.detail` object includes the `anchor` and `toggle` elements for the animation.
```js
// Log scroll events
var logScrollEvent = function (event) {
// The event type
console.log('type:', event.type);
// The anchor element being scrolled to
console.log('anchor:', event.detail.anchor);
// The anchor link that triggered the scroll
console.log('toggle:', event.detail.toggle);
};
// Listen for scroll events
document.addEventListener('scrollStart', logScrollEvent, false);
document.addEventListener('scrollStop', logScrollEvent, false);
document.addEventListener('scrollCancel', logScrollEvent, false);
```
### Methods
Smooth Scroll also exposes several public methods.
#### animateScroll()
Animate scrolling to an anchor.
```javascript
var scroll = new SmoothScroll();
scroll.animateScroll(
anchor, // Node to scroll to. ex. document.querySelector('#bazinga')
toggle, // Node that toggles the animation, OR an integer. ex. document.querySelector('#toggle')
options // Classes and callbacks. Same options as those passed into the init() function.
);
```
**Example 1**
```javascript
var scroll = new SmoothScroll();
var anchor = document.querySelector('#bazinga');
scroll.animateScroll(anchor);
```
**Example 2**
```javascript
var scroll = new SmoothScroll();
var anchor = document.querySelector('#bazinga');
var toggle = document.querySelector('#toggle');
var options = { speed: 1000, easing: 'easeOutCubic' };
scroll.animateScroll(anchor, toggle, options);
```
**Example 3**
```javascript
// You can optionally pass in a y-position to scroll to as an integer
var scroll = new SmoothScroll();
scroll.animateScroll(750);
```
#### cancelScroll()
Cancel a scroll-in-progress.
```javascript
var scroll = new SmoothScroll();
scroll.cancelScroll();
```
***Note:*** *This does not handle focus management. The user will stop in place, and focus will remain on the anchor link that triggered the scroll.*
#### destroy()
Destroy the current initialization. This is called automatically in the `init` method to remove any existing initializations.
```javascript
var scroll = new SmoothScroll();
scroll.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.
```html
...
...
var scroll = new SmoothScroll('.some-selector',{
header: '[data-scroll-header]'
});
```
## What's new?
Scroll duration now varies based on distance traveled. If you want to maintain the old scroll animation duration behavior, set the `speedAsDuration` option to `true`.
## Known Issues
### Reduce Motion Settings
This isn't really an "issue" so-much as a question I get a lot.
Smooth Scroll respects [the `Reduce Motion` setting](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) available in certain operating systems. In browsers that surface that setting, Smooth Scroll will not run and will revert to the default "jump to location" anchor link behavior.
I've decided to respect user preferences of developer desires here. This is *not* a configurable setting.
### `` styling
If the `` 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 `` 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.](https://github.com/cferdinandi/smooth-scroll/issues/49)
### 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 `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.
## Browser Compatibility
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.
*__Note:__ Smooth Scroll will not run—even in supported browsers—if users have `Reduce Motion` enabled. [Learn more in the "Known Issues" section.](#reduce-motion-settings)*
### Polyfills
Support back to IE9 requires polyfills for `closest()`, `requestAnimationFrame()`, and `CustomEvent()`. Without them, support starts with Edge.
Use the included polyfills version of Smooth Scroll, or include your own.
## License
The code is available under the [MIT License](LICENSE.md).