Xcopyco / dont-go

A small client-side library with zero dependencies to change the title and/or favicon of the page when it is inactive. :relieved:

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dont go

dont-go 😭

GitHub version npm version Bower version Build Status

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.08 kB. Note that You must include a default favicon in your webpage.

example

Install

Install with cdn

<script src="https://cdn.rawgit.com/mightyCrow/dont-go/master/lib/dont-go.min.js"></script>

Install with Bower

$ bower install dont-go

Install with npm

$ npm install dont-go

Usage

To use, simply call the function with options.

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

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

TODO 📝

  • Add ability to set timeout before title & favicon change.

Contributing

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

License

Created with ♥ by Tiaan du Plessis. Licensed under the MIT License.

About

A small client-side library with zero dependencies to change the title and/or favicon of the page when it is inactive. :relieved:

License:MIT License


Languages

Language:JavaScript 70.9%Language:HTML 29.1%