Permalink
Browse files

Documenting installation and configuration

  • Loading branch information...
1 parent 4e8fc3b commit 27b0aafe31ba07835c1d371886345d9f2dd34773 @jumph4x jumph4x committed Dec 11, 2012
Showing with 24 additions and 1 deletion.
  1. +24 −1 README.md
View
@@ -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**

2 comments on commit 27b0aaf

Any particular way only enabling scrolling horizontally or vertically for a particular antiscroll-wrap ?

Contributor

I would imagine by controlling width and height.

Please sign in to comment.