jQuery scrollToTop
A jquery plugin that automatically add a button to scroll to top.
Table of contents
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
Main files
dist/ ├── jquery-scrollToTop.js ├── jquery-scrollToTop.es.js ├── jquery-scrollToTop.min.js └── css/   ├── scrollToTop.css    └── scrollToTop.min.css
Quick start
Several quick start options are available:
Download the latest build
- Development - unminified
- Production - minified
Install From Bower
bower install jquery-scrollToTop --save
Install From Npm
npm install jquery-scrollToTop --save
Install From Yarn
yarn add jquery-scrollToTop
Build From Source
If you want build from source:
git clone [email protected]:amazingSurge/jquery-scrollToTop.git cd jquery-scrollToTop npm install npm install -g gulp-cli babel-cli gulp build
Done!
Requirements
jquery-scrollToTop
requires the latest version of jQuery
.
Usage
Including files:
<link rel="stylesheet" href="/path/to/scrollToTop.css"> <script src="/path/to/jquery.js"></script> <script src="/path/to/jquery-scrollToTop.js"></script>
Initialization
All you need to do is call the plugin on the element:
jQuery(function($) { $('body').scrollToTop({ skin: 'cycle' }); });
Examples
There are some example usages that you can look at to get started. They can be found in the examples folder.
Options
jquery-scrollToTop
can accept an options object to alter the way it behaves. You can see the default options by call $.scrollToTop.setDefaults()
. The structure of an options object is as follows:
{ distance: 200, speed: 1000, easing: 'linear', animation: 'fade', // fade, slide, none animationSpeed: 500, mobile: { width: 768, distance: 100, speed: 1000, easing: 'easeInOutElastic', animation: 'slide', animationSpeed: 200 }, trigger: null, // Set a custom triggering element. Can be an HTML string or jQuery object target: null, // Set a custom target element for scrolling to. Can be element or number text: 'Scroll To Top', // Text for element, can contain HTML skin: null, throttle: 250, namespace: 'scrollToTop' }
Methods
Methods are called on scrollToTop instances through the scrollToTop method itself. You can also save the instances to variable for further use.
// call directly $().scrollToTop('destroy'); // or var api = $().data('scrollToTop'); api.destroy();
jump()
Jump to top.
$().scrollToTop('jump');
enable()
Enable the scrollbar functions.
$().scrollToTop('enable');
disable()
Disable the scrollbar functions.
$().scrollToTop('disable');
destroy()
Destroy the scrollbar instance.
$().scrollToTop('destroy');
Events
jquery-scrollToTop
provides custom events for the plugin’s unique actions.
$('.the-element').on('scrollToTop::jump', function (e) { // on jump to top });
Event | Description |
---|---|
enable | Fired when the enable instance method has been called. |
disable | Fired when the disable instance method has been called. |
show | Fired when showing the toggle. |
hide | Fired when hiding the toggle. |
jump | Fired when jumping to the top. |
destroy | Fires when an instance is destroyed. |
No conflict
If you have to use other plugin with the same namespace, just call the $.scrollToTop.noConflict
method to revert to it.
<script src="other-plugin.js"></script> <script src="jquery-scrollToTop.js"></script> <script> $.scrollToTop.noConflict(); // Code that uses other plugin's "$().scrollToTop" can follow here. </script>
Browser support
Tested on all major browsers.
Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |
As a jQuery plugin, you also need to see the jQuery Browser Support.
Contributing
Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing. Make sure you're using the latest version of jquery-scrollToTop
before submitting an issue. There are several ways to help out:
- Bug reports
- Feature requests
- Pull requests
- Write test cases for open bug issues
- Contribute to the documentation
Development
jquery-scrollToTop
is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:
npm install -g gulp npm install -g babel-cli npm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
Changelog
To see the list of recent changes, see Releases section.
Copyright and license
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.