Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #42 from jumph4x/master

Explaining Installation and Configuration
  • Loading branch information...
commit 22738867613c255734b9bc420f42f2b40f916bb8 2 parents 4e8fc3b + 27b0aaf
@rauchg rauchg authored
Showing with 24 additions and 1 deletion.
  1. +24 −1 README.md
View
25 README.md
@@ -1,4 +1,3 @@
-
# Antiscroll: cross-browser native OSX Lion scrollbars
Antiscroll fixes a fundamental problem JavaScript UI developers commonly face:
@@ -26,6 +25,30 @@ the scrollbars popularized by OS X Lion that retains native properties.
Please click [here](http://learnboost.github.com/antiscroll/) to see it in
action.
+## Installation
+
+1. Wrap scrollable content with the class ```antiscroll-inner```
+1. Wrap the above with the class ```antiscroll-wrap```
+1. Include the following Javascript
+
+```javascript
+ $(function () {
+ $('.antiscroll-wrap').antiscroll();
+ });
+```
+
+### Configuration
+
+You may remove automatic scrollbar hiding by passing in a key-value to the ```antiscroll()``` function like so:
+
+```javascript
+ $(function () {
+ $('.antiscroll-wrap').antiscroll({
+ autoHide: false
+ });
+ });
+```
+
## What does it look like?
**Firefox 8 `overflow: scroll` and antiscroll on OS X**
Please sign in to comment.
Something went wrong with that request. Please try again.