README
jQuery asScroll
![prs-welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
A jquery plugin that click on the button to jump to the specified location.
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-asScroll.js
├── jquery-asScroll.es.js
└── jquery-asScroll.min.js
Quick start
Several quick start options are available:
Download the latest build
- Development - unminified
- Production - minified
Install From Bower
bower install jquery-asScroll --save
Install From Npm
npm install jquery-asScroll --save
Build From Source
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asScroll.git
cd jquery-asScroll
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
Requirements
jquery-asScroll
requires the latest version of jQuery
.
Usage
Including files:
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asScroll.js"></script>
Required HTML structure
<div data-scroll-target="basic">
Content
</div>
Initialization
All you need to do is call the plugin on the element:
jQuery(function($) {
$("body").asScroll();
});
Examples
There are some example usages that you can look at to get started. They can be found in the examples folder.
Options
jquery-asScroll
can accept an options object to alter the way it behaves. You can see the default options by call $.asScroll.setDefaults()
. The structure of an options object is as follows:
{
duration: 800,
easing: 'ease',
namespace: 'asScroll',
offsetTop: 50,
mobile: {
width: 768,
duration: 500,
easing: 'ease',
}
}
Methods
Methods are called on asScroll instances through the asScroll method itself. You can also save the instances to variable for further use.
// call directly
$().asScroll('method');
// or
var api = $().data('asScroll');
api.method();
Events
jquery-asScroll
provides custom events for the plugin’s unique actions.
$(document).on('active', function (e, direction, target) {
// on scroll target is active
});
Event | Description |
---|---|
active | Fires when the scroll target element is active on scrolling. |
No conflict
If you have to use other plugin with the same namespace, just call the $.asScroll.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-asScroll.js"></script>
<script>
$.asScroll.noConflict();
// Code that uses other plugin's "$().asScroll" 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-asScroll
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-asScroll
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.