tiaanduplessis / 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:

Do the old favicon switcheroo in under 500 bytes

Table of Contents

• About
• As Seen In
• 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 476 Bytes when minified. Note that You must include a default favicon in your webpage.

As Seen In

• This Clever Trick Brings Visitors Back When They Tab Away

Install

Install with cdn

<script src="https://unpkg.com/dont-go/lib/dont-go.js"></script>

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.

It is also possible to set the title property to an array of values and set an interval to switch between them as seen in the example below;

dontGo({
	title: ['Alternative title text', 'Another alternative title'],
	faviconSrc: 'path/to/Alternative/favicon.ico',
	interval: 1000 //1 second
});

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.

dont-go's Issues

dont-go.js:43 Uncaught TypeError: Cannot read property 'setAttribute' of undefined

I used cdn install. added the script to the head (with async) and other bit of script in the body section.

it throws following error:

dont-go.js:43 Uncaught TypeError: Cannot read property 'setAttribute' of undefined
     d  @   dont-go.js:43

this is a nodejs app. you can have a look here: http://kamva.ir/

CDN instructions are wrong

think you meant <script> and not <link rel='stylesheet'>

Add ability to set timeout before title & favicon change

Just moving it from README.md so that someone can take it up. (I will, at some stage!)

Btw, heads up for developing this quick hack. Looks good!

title and favicon doesn't change back

in our blog, we used cdn installation. it does changes title and favicon but it does not change back.

example: http://blog.kamva.ir/shop-builder-new-feature-digital-products/

Clean up build steps

Build process is in need of update.

RawGit is shutting down

Hey,

I see you recommend users fetching the code hosted using RawGit, but since they'll shut down soon, you should at some point remove that link. One side note: They say they'll stop serving the content in October 2019, but I already have seen cases where I can't fetch content from them.

Add feature to set multiple faviconSrc's

dontGo({
	title: ['Alternative title text', 'Another alternative title'],
	faviconSrc: ['path/to/Alternative/favicon.ico', 'path/to/Alternative/favicon2.ico'],
	interval: 1000 //1 second
});

Create a message loop

Hello everyone, first of all congratulations for the work. Really enjoyed.
Actually, it's not an issue, it's a question, I'm trying to create a messaging loop but without success so far. Can you help me ?

EN: Not working.

EN:
Hello,
Dont-go Available on my site https://prnt.sc/12z2ted

But: https://prnt.sc/12z2uml https://prnt.sc/12z2vc7 https://prnt.sc/12z2w3c
As you can see, it doesn't work.
GTranslate