dont-go

Do the old favicon switcheroo

Built with ❤︎ by Tiaan du Plessis and contributors

Table of Contents

Table of Contents

about

Install

Usage

Demo

Examples

Contributing

License

About

Dont-go is a small client-side library with zero dependencies to change the title and/or favicon of the page when it is inactive. Minified version weighs in at a whopping 1.47 kB when minified. Note that You must include a default favicon in your webpage.

Install

Install with cdn

<script src="https://cdn.rawgit.com/tiaanduplessis/dont-go/master/lib/dont-go.js"></script>
<!-- Or -->
<script src="https://unpkg.com/dont-go/lib/dont-go.js"></script>

Install with Bower

$ bower install dont-go

Install with npm

$ npm install dont-go

Install with yarn

$ yarn add dont-go

Usage

To use, simply call the function with options.

dontGo({
	title: 'Alternative title text right here!',
	faviconSrc: 'path/to/Alternative/favicon.ico',
	timeout: 5000 //5 seconds
});

The faviconSrc property is optional and will keep the same icon if not set.

The timeout property is optional, it takes an interval in milliseconds to before title & favicon change.

Demo

Check out the demo here.

examples

Please see the example directory for more usage examples.

Contributing

All Contributions are welcome! Please open up an issue if you would like to help out. :smile:

License

Licensed under the MIT License.

Icons made by Madebyoliver from www.flaticon.com is licensed by CC 3.0 BY.