Pretty, customisable, cross browser replacement scrollbars
Clone or download
Latest commit a5418c2 Sep 27, 2018

README.md

jScrollPane - cross browser custom scroll bars

jScrollPane is a jQuery plugin which allows you to replace a browser's default scroll bars (on an element which has overflow: auto) with a HTML structure that can be easily skinned using CSS.

To see a bunch of examples of jScrollPane in action please visit the jScrollPane website. All of the code for the website is available from this repository so please feel free to download and use it!

How to get it

CND

Up-to-date CND version is kindly provided by: CNDJS jScrollPane

NPM

Up-to-date Node version jScrollPane is also available from NPM.

Issues

Please feel free to make Bug reports against project but if you are making Issue in this project please read below.

Every Issue should have these

  • Brief topic which describes Issue
  • Short explanation about bug
  • Provide Browser info (version and platform) which have been used
  • Provide working example about Issue (JSFiddle or similar)

It would be nice to have these

  • Debug help about Issue if needed
  • Issue owner stays active until Issue is closed

Contributing

There is a simple grunt based build script in Gruntfile.js which will help to produce a minified version of jScrollPane if you make any modifications and want to submit a pull request.

To use it, make sure you have node, npm:

npm install

Then:

npm run build

Please remember to update the changelog in the comment at the header of both JS files when submitting a pull request.

Pull Request

These lines below may sound harsh or stop you making Pull Request. Please do Pull Request! This is very friendly project. These are just here because my time is very limited. So If you read lines below we all get along with less stress.

Please feel free to make Bug reports against project but Before making Pull Request please run your code against newest JSHint. Code with errors against JSHint won't be integrated or reviewed!.

Please also understand as Pull Request are made there is no time line or promise for that is would ever get integrated. This Volunteer organization and I do this when I have time. Remember everyone can help to review Pull Request.

If there is changes needed to make in Pull Request it's up to Pull Request owner to make sure they are corrected.

Pull Requests should at least have these

  • Pull Request should at least contain topic what it's changing
  • Brief explanation why this should be integrated and what have been changed
  • If there is new initialize properties they they should be documented to documentation
  • If this Pull Request generates new functionality which ain't having example that should be provided.

License

jScrollPane is dual-licensed under the GPL 2 license and the MIT license.