Skip to content

Commit 27b0aaf

Browse files
committed
Documenting installation and configuration
1 parent 4e8fc3b commit 27b0aaf

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Antiscroll: cross-browser native OSX Lion scrollbars
32

43
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.
2625
Please click [here](http://learnboost.github.com/antiscroll/) to see it in
2726
action.
2827

28+
## Installation
29+
30+
1. Wrap scrollable content with the class ```antiscroll-inner```
31+
1. Wrap the above with the class ```antiscroll-wrap```
32+
1. Include the following Javascript
33+
34+
```javascript
35+
$(function () {
36+
$('.antiscroll-wrap').antiscroll();
37+
});
38+
```
39+
40+
### Configuration
41+
42+
You may remove automatic scrollbar hiding by passing in a key-value to the ```antiscroll()``` function like so:
43+
44+
```javascript
45+
$(function () {
46+
$('.antiscroll-wrap').antiscroll({
47+
autoHide: false
48+
});
49+
});
50+
```
51+
2952
## What does it look like?
3053

3154
**Firefox 8 `overflow: scroll` and antiscroll on OS X**

0 commit comments

Comments
 (0)