🌜
🌞
jscrollpane

jscrollpane

v2.2.3-rc.2

jScrollPane - cross browser custom scroll bars

npm install jscrollpane

README

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

CDN

Up-to-date CDN version is kindly provided by: CDNJS jScrollPane

NPM

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

Ruby on Rails

jScrollPane packed as Ruby gem is also available.

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.

Release Notes

2.2.3-rc.2
By Tuukka Pasanen • Published on June 26, 2020

There is fix for two jQuery security Issues:

  • Jquery 3.5.0: Security Fix Closing HTML Tags #376
  • Jquery 4.0: Use of number-typed values is deprecated #377

All the scripts that are not part of jquery.jscrollpane.js like jquery.mousewheel.js and mwheelIntent.js are updated to follow jQuery 3.x binding system. There is also work on stickToBottom and stickToRight settings. They work little bit differently if you turn of maintainPosition setting to false. After that they get you to bottom or right everytime reinitialize()-function is run. If you have maintainPosition set to true (which is default) then user have to go bottom and after that it stays at bottom. Script is also run through Prettier beautifier which also made run everytime Grunt is excecuted and code which doesn't go through prettier is not pretty enough.

Be sure to test before taking this to production

2.2.2
By Tuukka Pasanen • Published on May 6, 2020

As everything starts to rot if you don't maintain it. This just release to update NPM packages and remove problematic dependencies.

2.2.1
By Tuukka Pasanen • Published on September 27, 2018

Changes are the same as Relase Candidate 2.

Please check CSS changes before taking this in production! Again CSS has changed please check that it doesn't break you or your system.

  • Changes

    • CSS files in project haven't changed for a while and they are base CSS for many projects.
  • Merged

    • vitch/jScrollPane#360 Register to globally available version of jQuery

Besides these don't worry be happy!

2.2.1-rc.2
By Tuukka Pasanen • Published on June 14, 2018

As sucked again in NPM skipped Release Candidate 1! This is just same but as NPM I have to rise number

  • Changes

    • CSS files in project haven't changed for a while and they are base CSS for many projects. Fixing something can lead mass destruction of web projects. Please these changes before taking this in production.
  • Merged

    • vitch/jScrollPane#360 Register to globally available version of jQuery

Besides that happy summer holidays in Norther hemisphere..

2.2.0
By Tuukka Pasanen • Published on May 16, 2018

jScrollPane have had until now resize system which just polls changes in page and that was little bit resource hog event with newest machines. Version 2.2.0 introduces new Resize Sensor (which have one have to enable with new parameter). Please see new example HTML file how to use it and does it fit to your system.

  • Other changes are

    • README.md had small face lift with CND and NPM info.
  • Merged

    • vitch/jScrollPane#361
    • vitch/jScrollPane#359
2.2.0-rc.1
By Tuukka Pasanen • Published on April 28, 2018

It's spring in my hemisphere and Mayday is coming. For this release I recommend heavy testing! There is new way to watch changes of the screen size or size changes of component size. Another change is minimal NPM build adoption. So make sure you check them out!

For background music I can recommend (As I don't know any good wines) Members of Mayday: Mayday Anthem from marvelous year 1992.

In NPM database this one is now tagged as 'next' as bug #358 pointed out

  • Merged
    • vitch/jScrollPane#361
    • vitch/jScrollPane#359
2.1.3
By Tuukka Pasanen • Published on April 4, 2018

If you are using Webpack you should really update to this release as this one really works with it!

  • There is no changes in code only package.json changes so if it's working for you it's not borked by me or anyone!
  • Fix issue #356 and people who use Webpack should be happy now!
  • Move examples to own directory from polluting root

If this release makes your code dance Salsa20 then please submit new Issue

2.1.3-rc.2
By Tuukka Pasanen • Published on March 13, 2018

As Node is fairly new system and Webpack is even newer system. There is much documentation but there ain't much how to solve problems. Long story short (Long story see Issue #356): good news is that Webpack is working now and bad news is that there is change in package.json which can break your build.

If you use Webpack or rely on NPM-package manager you should really test this before this is released because this is how we roll ever after from this

2.1.3-rc.1
By Tuukka Pasanen • Published on March 5, 2018

My knowledge how people like to use jScrollPane is getting wider and wider. As breaking some people build systems I update this again in trying to get it working for all.

  • Also *.html files are moved to examples
  • build/GruntFile.js is now /GruntFile.js

Again if this break for you. Please open Issue so it would be ironed out before 2.1.3

2.1.2
By Tuukka Pasanen • Published on February 16, 2018

This small minor release is all about getting NPM package manager back in business. It doesn't fix anything nor it doesn't bring any new functionality.

General

License
(MIT OR GPL-2.0)
Typescript Types
Tree-shakeable
No

Popularity

GitHub Stargazers
2,171
Community Interest
2,964
Number of Forks
650

Maintenance

Commits
11/2110/2202
Last Commit
Open Issues
20
Closed Issues
246
Open Pull Requests
2
Closed Pull Requests
70

Versions

Versions Released
11/2110/2201
Latest Version Released
Jun 26, 2020
Current Tags
latest2.2.3-rc.2
next2.2.1-rc.2

Contributors

vitch
vitch
Commits: 281
illuusio
illuusio
Commits: 63
aivopaas
aivopaas
Commits: 16
ept
ept
Commits: 8
abhishekdev
abhishekdev
Commits: 5
brandonaaron
brandonaaron
Commits: 4
lpetrov
lpetrov
Commits: 4
rvock
rvock
Commits: 2
edull24
edull24
Commits: 1
tim-sge
tim-sge
Commits: 1
yukulele
yukulele
Commits: 1
brinley
brinley
Commits: 1
IsaacSchemm
IsaacSchemm
Commits: 1
pavel-sedek
pavel-sedek
Commits: 1
codrin-iftimie
codrin-iftimie
Commits: 1