favorite-icon

A small library for manipulating the favicon.

Usage no npm install needed!

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

README

⭐ Favorite Icon

NPM version NPM downloads Bundlephobia

A small library for manipulating the favicon.

Installation

npm install favorite-icon

Using

import FaviconIcon from 'favorite-icon';

FaviconIcon.set('/my-icon.png');

API

Favicon.set(src: string | HTMLCanvasElement)

Set the favicon with your own image.

import FaviconIcon from 'favorite-icon';

Favicon.set('./image.png');

// or

Favicon.set('data:image/png;base64,...');

// or

const canvas = document.createElement('canvas');
//...
Favicon.set(canvas);

Favicon.reset()

Reset the favicon.

import FaviconIcon from 'favorite-icon';

// ...

Favicon.reset();

Browser support

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

License

MIT License