Ouibounce

> Originally created by Carl Sednaoui from MailCharts. Maintained and improved by generous contributors.

 

Ouibounce: A small library enabling you to display a modal before a user leaves your website.


> Quick note: Let me know if you end up using Ouibounce. I'd love to hear about your project / see Ouibounce in the wild :)

$3

This library helps you increase landing page conversion rates. From my experience, you can expect a lift of 7% to 15% depending on your audience, traffic type (paid or unpaid) and copy.

Talking about copy... __please__ use Ouibounce to __provide value__ to your visitors. With tools like these __it's very easy to create something spammy-looking__.

Not sure what I mean by _provide value_? Here are a few ideas to get your creative juices flowing:

- Free ebook
- Upcoming webinar invite
- Exclusive access to XYZ
- A full educational course
- Valuable content

Demo / Examples

- Example #1
- Example #2

Modal inspiration

I've designed a few modals just for you. Feel free to use these as inspiration.

!fancy with content
!fancy no header
!simple
!simple with book
!simple with feedback

Installation

You have a few options to choose from:

- Download the minified or unminified script and include it on your page
- Get Ouibounce from cdnjs.com
- Use Bower: curl http://bower.herokuapp.com/packages/ouibounce
- Use NPM: npm install ouibounce

_Note_: Ouibounce is wrapped by a umd wrapper, so if you are using _requirejs/amd_ or _commonjs/browserify_, it will still work fine.

Usage

1. Create a hidden modal
1. Select the modal with vanilla JavaScript (or jQuery) and call ouibounce
1. Optional: Save the function's return value to use the public API, allowing you to fire or disable Ouibounce on demand

_Example:_
``js
ouibounce(document.getElementById('ouibounce-modal'));
`

_Example with jQuery:_
`js
ouibounce($('#ouibounce-modal')[0]);
`

_Example using the public api:_
`js
var modal = ouibounce(document.getElementById('ouibounce-modal'));
modal.fire()
`

$3

Ouibounce offers a few options, such as:

- Sensitivity
- Aggressive mode
- Timer
- Delay
- Callback
- Cookie expiration
- Cookie domain
- Cookie name
- Sitewide cookie
- Chaining options

##### Sensitivity
Ouibounce fires when the mouse cursor moves close to (or passes) the top of the viewport. You can define how far the mouse has to be before Ouibounce fires. The higher value, the more sensitive, and the more quickly the event will fire. _Defaults to 20._

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { sensitivity: 40 });
`

##### Aggressive mode
By default, Ouibounce will only fire once for each visitor. When Ouibounce fires, a cookie is created to ensure a _non obtrusive_ experience.

There are cases, however, when you may want to be more aggressive (as in, you want the modal to be elegible to fire anytime the page is loaded/ reloaded). An example use-case might be on your paid landing pages. If you enable aggressive, the modal will fire any time the page is reloaded, for the same user.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { aggressive: true });
`

##### Set a min time before Ouibounce fires
By default, Ouibounce won't fire in the first second to prevent false positives, as it's unlikely the user will be able to exit the page within less than a second. If you want to change the amount of time that firing is surpressed for, you can pass in a number of milliseconds to timer.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { timer: 0 });
`

##### Delay
By default, Ouibounce will show the modal immediately. You could instead configure it to wait x milliseconds before showing the modal. If the user's mouse re-enters the body before delay ms have passed, the modal will not appear. This can be used to provide a "grace period" for visitors instead of immediately presenting the modal window.

_Example:_

`js
// Wait 100 ms
ouibounce(document.getElementById('ouibounce-modal'), { delay: 100 });
`

##### Callback
You can add a callback, which is a function that will run once Ouibounce has been triggered, by using the callback option.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { callback: function() { console.log('Ouibounce fired!'); } });
`

##### Cookie expiration
Ouibounce sets a cookie by default to prevent the modal from appearing more than once per user. You can add a cookie expiration (in days) using cookieExpire to adjust the time period before the modal will appear again for a user. By default, the cookie will expire at the end of the session, which for most browsers is when the browser is closed entirely.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { cookieExpire: 10 });
`

##### Cookie domain
Ouibounce sets a cookie by default to prevent the modal from appearing
more than once per user. You can add a cookie domain using
cookieDomain to specify the domain under which the cookie should work.
By default, no extra domain information will be added. If you need a
cookie to work also in your subdomain (like blog.example.com and
example.com), then set a cookieDomain such as .example.com (notice the
dot in front).

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { cookieDomain:
'.example.com' });
`

##### Cookie name
You can specify cookie name passing cookieName: 'customCookieName'.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { cookieName: 'customCookieName' });
`

##### Sitewide cookie
You can drop sitewide cookies by using passing sitewide: true.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), { sitewide: true });
`

##### Chaining options
The options are just javascript objects, you can therefore combine multiple options.

_Example:_
`js
ouibounce(document.getElementById('ouibounce-modal'), {
aggressive: true,
sitewide: true,
cookieDomain: '.example.com',
timer: 0,
callback: function() { console.log('ouibounce fired!'); }
});
`

$3

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.

_Example:_
`js
var modal = ouibounce(document.getElementById('ouibounce-modal'));
modal.fire(); // fire the ouibounce event
modal.disable() // disable ouibounce, it will not fire on page exit
modal.disable({ cookieExpire: 50, sitewide: true }) // disable ouibounce sitewide for 50 days.
`

##### Disable options
The disable function accepts a few options:
- Cookie expiration
- Cookie domain
- Cookie name
- Sitewide cookie

$3


If you want to use this library with other plugins — such as Vex — you can call ouibounce with false. See #30 for discussion.


`js
var _ouibounce = ouibounce(false, {
callback: function() { console.log('ouibounce fired!'); }
});
``

##### Twitter Bootstrap
If you're trying to use Ouibounce with Twitter Bootstrap and are simply copying the example code I've included in the demo, you might run into some problems. See #66 to fix this.

$3

If you'd like Ouibounce to work in legacy JS engines (IE8 and below, for example), you'll need to add a shim such as es5-shim.

$3

Tomaž wrote a great tutorial on how to build your own WordPress opt-in form.

Kevin Weber wrote wBounce, a WordPress plugin. I personally have __not__ tested it, but have heard it works really well. Check it out.

$3

- This library provides no guarantees.
- If you are intersted in contributing, make sure to check out contributing.md.
- Licensed under MIT.
- Special thanks to Zertosh, Jenius and all other contributors.