Skip to content

Explaining Installation and Configuration #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2012
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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