Skip to content

Commit

Permalink
Documenting installation and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
jumph4x committed Dec 11, 2012
1 parent 4e8fc3b commit 27b0aaf
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Antiscroll: cross-browser native OSX Lion scrollbars

Antiscroll fixes a fundamental problem JavaScript UI developers commonly face:
Expand Down Expand Up @@ -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**
Expand Down

2 comments on commit 27b0aaf

@thinkpozzitive
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jumph4x
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would imagine by controlling width and height.

Please sign in to comment.