A jquery plugin helps scroll the list that is larger than its container.
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
dist/
├── jquery-asHoverScroll.js
├── jquery-asHoverScroll.es.js
└── jquery-asHoverScroll.min.js
Several quick start options are available:
- Development - unminified
- Production - minified
bower install jquery-asHoverScroll --save
npm install jquery-asHoverScroll --save
yarn add jquery-asHoverScroll
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asHoverScroll.git
cd jquery-asHoverScroll
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
jquery-asHoverScroll
requires the latest version of jQuery
.
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asHoverScroll.js"></script>
<div class="example">
<ul>
<li></li>
<li></li>
</ul>
</div>
All you need to do is call the plugin on the element:
jQuery(function($) {
$('.example').asHoverScroll();
});
There are some example usages that you can look at to get started. They can be found in the examples folder.
jquery-asHoverScroll
can accept an options object to alter the way it behaves. You can see the default options by call $.asHoverScroll.setDefaults()
. The structure of an options object is as follows:
{
namespace: 'asHoverScroll',
list: '> ul',
item: '> li',
exception: null,
direction: 'vertical',
fixed: false,
mouseMove: true,
touchScroll: true,
pointerScroll: true,
useCssTransforms: true,
useCssTransforms3d: true,
boundary: 10,
throttle: 20,
// callbacks
onEnter() {
$(this).siblings().removeClass('is-active');
$(this).addClass('is-active');
},
onLeave() {
$(this).removeClass('is-active');
}
}
Methods are called on asHoverScroll instances through the asHoverScroll method itself. You can also save the instances to variable for further use.
// call directly
$().asHoverScroll('enable');
// or
var api = $().data('asHoverScroll');
api.enable();
Enable the hoverscroll functions.
$().asHoverScroll('enable');
Disable the hoverscroll functions.
$().asHoverScroll('disable');
Destroy the hoverscroll instance.
$().asHoverScroll('destroy');
jquery-asHoverScroll
provides custom events for the plugin’s unique actions.
$('.the-element').on('asHoverScroll::ready', function (e) {
// on instance ready
});
Event | Description |
---|---|
init | Fires when the instance is setup for the first time. |
ready | Fires when the instance is ready for API use. |
enable | Fired when the enable instance method has been called. |
disable | Fired when the disable instance method has been called. |
destroy | Fires when an instance is destroyed. |
If you have to use other plugin with the same namespace, just call the $.asHoverScroll.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-asHoverScroll.js"></script>
<script>
$.asHoverScroll.noConflict();
// Code that uses other plugin's "$().asHoverScroll" can follow here.
</script>
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.
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-asHoverScroll
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
jquery-asHoverScroll
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.
To see the list of recent changes, see Releases section.
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.