Skip to content

Commit

Permalink
Update to 1.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
azoff committed Aug 25, 2010
1 parent 1b494d3 commit de1f1f1
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions README.md
Expand Up @@ -15,23 +15,19 @@ http://jquery.org/license
Usage
-----
<pre>$(selector).overscroll([options]);</pre>
<dl>
<dt>selector</dt>
<dd>The jQuery selector, targeting an element to apply overscroll to</dd>
<dt>options</dt>
<dd>
An optional JavaScript object that you may pass if you would like to customize the experience of the overscroll element. Below is a list of properties that you may set on the options object and their respective effect.
* `options.showThumbs` `{Boolean: true}`
- Designates whether or not to show the scroll-bar thumbs on the scrollable container
* `options.openedCursor` `{String: 'opened.cur'}`
- A url pointing at a .cur file to be used as the cursor when hovering over the overscrolled element
* `options.closedCursor` `{String: 'closed.cur'}`
- A url pointing at a .cur file to be used as the cursor when dragging the overscrolled element
* `options.direction` `{String: 'auto'}`
- The scroll direction of the overscrolled element, by default it will auto-detect the available directions. You can also restrict direction by setting this property equal to 'vertical' or 'horizontal'
</dl>
<dd>
</dl>

+ selector
The jQuery selector, targeting an element to apply overscroll to
+ `options`
An optional JavaScript object that you may pass if you would like to customize the experience of the overscroll element. Below is a list of properties that you may set on the options object and their respective effect.
* `options.showThumbs` `{Boolean: true}`
- Designates whether or not to show the scroll-bar thumbs on the scrollable container
* `options.openedCursor` `{String: 'opened.cur'}`
- A url pointing at a .cur file to be used as the cursor when hovering over the overscrolled element
* `options.closedCursor` `{String: 'closed.cur'}`
- A url pointing at a .cur file to be used as the cursor when dragging the overscrolled element
* `options.direction` `{String: 'auto'}`
- The scroll direction of the overscrolled element, by default it will auto-detect the available directions. You can also restrict direction by setting this property equal to 'vertical' or 'horizontal'

Notes
-----
Expand Down

0 comments on commit de1f1f1

Please sign in to comment.