/dont-go

A small client-side library with zero dependencies to change the title and/or favicon of the page when it is inactive. 😌
  1. HTML 68.2%
  2. JavaScript 31.8%
HTML JavaScript

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit c5aacc9 Mar 28, 2017 @tiaanduplessis committed on GitHub Merge pull request #8 from tiaanduplessis/greenkeeper/standard-9.0.0 
Update standard to the latest version 🚀
Permalink
Failed to load latest commit information.
example Update & cleanup build process Feb 23, 2017
lib Update & cleanup build process Feb 23, 2017
media Add public site Jan 22, 2017
public Add public site Jan 22, 2017
src Update & cleanup build process Feb 23, 2017
.eslintignore feat(Build): Initial commit Sep 18, 2016
.gitignore feat(Build): Initial commit Sep 18, 2016
.travis.yml chore(CI): Add travis CI to project Sep 18, 2016
README.md 1.0.8 Feb 23, 2017
bower.json Update & cleanup build process Feb 23, 2017
package.json chore(package): update standard to version 9.0.0 Feb 28, 2017
webpack.config.babel.js Update & cleanup build process Feb 23, 2017
yarn.lock Update & cleanup build process Feb 23, 2017

README.md

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

    leo

    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

    example

    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. 😄

    License

    Licensed under the MIT License.

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