Registry / devops / vite-plugin-hashed-favicons

vite-plugin-hashed-favicons

library2.1.0jsnpmunverified

A Vite plugin that generates hashed favicons (ico, png, masked, apple-touch, web manifest) from a single optimized SVG source. Current stable version is 2.1.0 (April 2026), with frequent updates following a semver cadence. Unlike heavy favicon generators, this plugin follows the minimalist Evil Martians approach (2021) producing only essential files with content-hash filenames for cache busting. Ships TypeScript types. Requires Vite ^5.0.12 || ^6.0.0 || ^7.0.0 || ^8.0.0 as peer dependency. Key differentiator: zero runtime dependencies, SVG-only input, simplified output set.

devops web-framework

npm install vite-plugin-hashed-favicons

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-HASHED

vite-plugin-hashed-favicons

devopsjavascriptv2.1.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

favicons

✓ import favicons from 'vite-plugin-hashed-favicons'

✗ import { favicons } from 'vite-plugin-hashed-favicons'

Default export only; named import will give undefined

virtual:hashed-favicons

✓ import favicons from 'virtual:hashed-favicons'

✗ import { favicons } from 'virtual:hashed-favicons'

Virtual module available only when plugin option 'inject' is false. Also, add 'vite-plugin-hashed-favicons/virtual' to tsconfig types for TypeScript support.

require('vite-plugin-hashed-favicons')

✓ const favicons = require('vite-plugin-hashed-favicons');

CommonJS require is supported. Ensure your vite config file uses CJS or .cjs extension if mixing module systems.

Configures Vite to generate hashed favicons from an SVG source with custom web manifest settings.

// vite.config.ts import favicons from 'vite-plugin-hashed-favicons'; import { defineConfig } from 'vite'; export default defineConfig({ plugins: [ favicons('./src/assets/favicon.svg', { webManifest: { name: 'My App', start_url: '/', display: 'standalone', background_color: '#ffffff', theme_color: '#000000', }, inject: true, // default: automatically inject into HTML }), ], });

Debug

Known issues

breakingv2.0.0 replaces the `favicons` package with an own implementation, generating fewer icons and requiring SVG input only.

fix

Upgrade from v1: ensure source is an optimized SVG file (not PNG). Remove any options related to the old `favicons` package. Check the generated set of icons – only essential ones remain.

affects: >=2.0.0

breakingv2.0.0 removed support for multiple favicon sizes; only 32x32 ico and standard PNG variants are produced.

fix

If you relied on specific sizes (e.g., 16x16, 48x48), you must generate them separately or adjust expectations.

affects: >=2.0.0

gotchaThe `inject` option defaults to true (auto-inject into HTML). If you want to use the virtual module, you must explicitly set `inject: false`.

fix

Set inject: false in plugin options when using virtual:hashed-favicons.

affects: >=2.1.0

gotchaPeer dependency `vite` must satisfy either ^5.0.12, ^6.0.0, ^7.0.0, or ^8.0.0. Older or newer major versions will cause install warnings or errors.

fix

Ensure your project uses Vite 5, 6, 7, or 8. For Vite 4 or below, keep version 1.x or upgrade Vite.

affects: >=2.0.7

deprecatedv1.x is deprecated and no longer maintained. It relied on the external `favicons` package and had security issues with subdependencies.

fix

Migrate to v2.0.0+ as described in the changelog. Replace source image with SVG and adjust configuration.

affects: <2.0.0

Errors

Common errors & fixes

Error: Could not resolve 'virtual:hashed-favicons'

Using the virtual module without disabling injection in plugin options.

fix

Add `inject: false` to the favicons plugin options.

TypeError: favicons is not a function

Using named import instead of default import.

fix

Use `import favicons from 'vite-plugin-hashed-favicons'` (no curly braces).

Module not found: Error: Can't resolve 'vite-plugin-hashed-favicons'

Package not installed or incorrect peer dependency version.

fix

Run `npm install vite-plugin-hashed-favicons` and ensure Vite version is ^5.0.12 || ^6.0.0 || ^7.0.0 || ^8.0.0.

Upgrade

Version history

2.1.0latest on npm

Audit

Dependencies

viterequiredPeer dependency required for plugin hooks and build pipeline

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/DASPRiD/vite-plugin-hashed-favicons ↗

packagehttps://www.npmjs.com/package/vite-plugin-hashed-favicons ↗