Skip to content

Commit

Permalink
Address dummy object issue. Close #30
Browse files Browse the repository at this point in the history
  • Loading branch information
carlsednaoui committed May 13, 2014
1 parent 78a5388 commit 57eb760
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ ouibounce(document.getElementById('ouibounce-modal'), {
});
```

### OuiBounce API
### Ouibounce API

If you save the object returned by the `ouibounce` function, you get access to a small public API. Use this API to `fire` or `disable` OuiBounce on demand.

Expand All @@ -129,6 +129,9 @@ modal.fire(); // fire the ouibounce event
modal.disable() // disable ouibounce, it will not fire on page exit
```

### Using OuiBounce with other libraries
If you want to use this library with other plugins — such as [Vex](http://github.hubspot.com/vex/docs/welcome/) — you can create a blank dummy object, then place the vex modal code in the callback. See #[30](/issues/30) for discussion.

### Miscellaneous

- This library provides no guarantees.
Expand Down

0 comments on commit 57eb760

Please sign in to comment.