favorite-icon-status

A small library for status manipulating in favicon.

Usage no npm install needed!

<script type="module">
  import favoriteIconStatus from 'https://cdn.skypack.dev/favorite-icon-status';
</script>

README

⚠️ Favorite Icon Status

NPM version NPM downloads Bundlephobia

A small library for status manipulating in favicon.

Installation

npm install favorite-icon-status

Demo

Using

import FaviconStatus from 'favorite-icon-status';

const status = new FaviconStatus();
status.set('ok'); // 'ok', 'error' or 'warning'

Advanced options

import FaviconStatus from 'favorite-icon-status';

const status = new FaviconStatus({
    faviconSrc: '/icons/favicon.png'
});

status.set('ok'); // 'ok', 'error' or 'warning'

API

.set(status: 'ok' | 'error' | 'warning')

Set the favicon with status.

import FaviconStatus from 'favorite-icon-status';

const status = new FaviconStatus();
status.set('ok'); // 'ok', 'error' or 'warning'

.reset()

Reset the favicon.

import FaviconStatus from 'favorite-icon-status';

const status = new FaviconStatus();

// ...

status.reset();

Browser support

  • Chrome: ✅
  • Firefox: ✅
  • Opera: ✅
  • IE: ❌
  • Edge: ❌
  • Safari: ❌ (Safari hides favicons)

License

MIT License