cartodb/perfect-scrollbar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #259 from smithl/patch-1

Browse Source 
Update README.md
This commit is contained in:
Hyunje Alex Jun 2014-12-02 18:27:10 +00:00
commit d6558c492d
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -8,8 +8,8 @@ Why perfect-scrollbar?
I worked on a personal project recently, and I was trying to find the jQuery scrollbar plugin that's *perfect*. But there was no *perfect* scrollbar plugin. That's why I decided to make one. I worked on a personal project recently, and I was trying to find the jQuery scrollbar plugin that's *perfect*. But there was no *perfect* scrollbar plugin. That's why I decided to make one.
perfect-scrollbar is very tiny but *perfect* (for me, and maybe for the most of developers) jQuery scrollbar plugin. perfect-scrollbar is very tiny but *perfect* (for me, and maybe for most developers) jQuery scrollbar plugin.
I hope you love this! I hope you love it!
Demo: http://noraesae.github.com/perfect-scrollbar/ Demo: http://noraesae.github.com/perfect-scrollbar/
@ -31,15 +31,15 @@ Yes! the only thing that's not *perfect* is my English.
* perfect-scrollbar has some requirements, but doesn't change or add any style on original elements. * perfect-scrollbar has some requirements, but doesn't change or add any style on original elements.
* perfect-scrollbar is designed not to have width or height. It's fixed on the right and bottom side of the container. * perfect-scrollbar is designed not to have width or height. It's fixed on the right and bottom side of the container.
* You can change nearly all css styles of the scrollbar. The scrollbar design has no dependency on scripts. * You can change nearly all css styles of the scrollbar. The scrollbar design has no dependency on scripts.
* perfect-scrollbar support 'update' function. Whenever you need to update the size or position of the scrollbar, just update. * perfect-scrollbar supports an 'update' function. Whenever you need to update the size or position of the scrollbar, just update.
* Additionally, perfect-scrollbar do use 'scrollTop' and 'scrollLeft', not absolute position or something messy. * Additionally, perfect-scrollbar uses 'scrollTop' and 'scrollLeft', not absolute positioning or something messy.
It's cool, isn't it? It's cool, isn't it?
Install Install
------- -------
You can download the latest stable version with download links in [Github Page](http://noraesae.github.io/perfect-scrollbar/). You also can find all releases in [Releases](https://github.com/noraesae/perfect-scrollbar/releases) page. You can download the latest stable version with download links at [Github Page](http://noraesae.github.io/perfect-scrollbar/). You also can find all releases at [Releases](https://github.com/noraesae/perfect-scrollbar/releases) page.
If you want to use the development version of the plugin, use the source files which are not minified. They're in the `src` directory. The development version may be unstable, but some known bugs can be fixed. If you want to use the development version of the plugin, use the source files which are not minified. They're in the `src` directory. The development version may be unstable, but some known bugs can be fixed.
@ -65,16 +65,16 @@ You can also load it from [cdnjs](http://cdnjs.com/). It is registered as [`jque
Requirements Requirements
------------ ------------
To make this plugin *perfect*, some requirements were not avoidable. But they're all very trivial and there's nothing to worry about. To make this plugin *perfect*, some requirements were unavoidable. But, they're all very trivial and there is nothing to worry about.
* the container must have a 'position' css style. * the container must have a 'position' css style.
* the container must have an 'overflow:hidden' css style. * the container must have an 'overflow:hidden' css style.
* the scrollbar's position must be 'absolute'. * the scrollbar's position must be 'absolute'.
* the scrollbar-x must have a 'bottom' css style, and the scrollbar-y must have a 'right' css style. * the scrollbar-x must have a 'bottom' css style, and the scrollbar-y must have a 'right' css style.
The requirement below is for perfect-scrollbar <= 0.3.4 The below requirement is for perfect-scrollbar <= 0.3.4
* there must be the *one* content element(like div) for the container. * there must be the *one* content element (like div) for the container.
Optional parameters Optional parameters
------------------- -------------------
@ -175,12 +175,12 @@ $("#Demo").scrollTop(0);
$("#Demo").perfectScrollbar('update'); $("#Demo").perfectScrollbar('update');
``` ```
Also you can get the informations about how to use the plugin from example codes in the `examples` directory of the source tree. Also you can get information about how to use the plugin from code in the `examples` directory of the source tree.
Contribution Contribution
------------ ------------
#### Please read [Contributing](https://github.com/noraesae/perfect-scrollbar/wiki/Contributing) in the wiki before making any contibution. #### Please read [Contributing](https://github.com/noraesae/perfect-scrollbar/wiki/Contributing) in the wiki before making any contribution.
I *really* welcome contributions! Please feel free to fork and issue pull requests when... I *really* welcome contributions! Please feel free to fork and issue pull requests when...
@ -194,7 +194,7 @@ For IE problems, please refer to [IE Support](https://github.com/noraesae/perfec
IE Support IE Support
---------- ----------
The plugin would work in IEs >= IE9(not well, though). The plugin would work in IEs >= IE9 (not well, though).
**The patches to fix problems in IE<=8 won't be accepted.** **The patches to fix problems in IE<=8 won't be accepted.**
@ -205,7 +205,7 @@ Helpdesk
If you have any idea to improve this project or any problem using this, please feel free to upload an [issue](https://github.com/noraesae/perfect-scrollbar/issues). If you have any idea to improve this project or any problem using this, please feel free to upload an [issue](https://github.com/noraesae/perfect-scrollbar/issues).
For the problems frequently asked, there's a [FAQ](https://github.com/noraesae/perfect-scrollbar/wiki/FAQ) wiki page. Please check the page before uploading an issue. For common problems there is a [FAQ](https://github.com/noraesae/perfect-scrollbar/wiki/FAQ) wiki page. Please check the page before uploading an issue.
License License
------- -------