Skip to content

Commit

Permalink
Add timer option to README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlsednaoui committed Feb 11, 2014
1 parent 9de7c85 commit b3a576a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ OuiBounce offers a few options, such as:

- Sensitivity
- Aggressive mode
- Timer

__Configuring sensitivity:__ Use it to define how far your mouse has to be from the window breakpoint. The higher value the more sensitive. _Defaults to 20._

Expand All @@ -51,6 +52,11 @@ Here's how to enable aggressive mode:
$('#ouibounce-modal').ouibounce({aggressive: true});
```

__Set a min time before OuiBounce fires:__ By default, OuiBounce won't fire in the first second. You can pass a timer option like so:
```js
$('#ouibounce-modal').ouibounce({timer: 0});
```

__To remove ouibounce:__ Call
```js
$('html').off('mouseout.ouibounce');
Expand Down

0 comments on commit b3a576a

Please sign in to comment.