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
muslnode 18–223 runs
build_error
glibcnode 18–223 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ViteFaviconsPlugin
✓ import { ViteFaviconsPlugin } from 'vite-plugin-favicon'
✗ const ViteFaviconsPlugin = require('vite-plugin-favicon')
ESM import is the standard; CommonJS require works but not recommended for Vite projects.
ViteFaviconsPlugin (default)
✓ import ViteFaviconsPlugin from 'vite-plugin-favicon'
✗ import { default as ViteFaviconsPlugin } from 'vite-plugin-favicon'
Plugin also has a default export, but named export is more consistent with Vite plugins.
ViteFaviconsPlugin (type)
✓ import type { ViteFaviconsPlugin } from 'vite-plugin-favicon'
Type import is available for TypeScript usage.
Basic setup with a custom logo path and optional favicon configuration, demonstrating zero-config usage and TypeScript integration.
// vite.config.ts
import { defineConfig } from 'vite';
import { ViteFaviconsPlugin } from 'vite-plugin-favicon';
export default defineConfig({
plugins: [
ViteFaviconsPlugin('src/assets/logo.png', {
// Optional: override default favicon generation settings
favicons: {
appName: 'My App',
appShortName: 'App',
appDescription: 'My awesome app',
background: '#ffffff',
theme_color: '#333333',
display: 'standalone',
orientation: 'portrait',
start_url: '.',
version: '1.0.0',
logging: false,
html: 'index.html',
pipeHTML: true,
replace: true
}
})
]
});
Errors
Common errors & fixes
Error: Cannot find module 'vite-plugin-favicon'
Package not installed or not in node_modules
fixRun 'npm install --save-dev vite-plugin-favicon'
Error: The service you have requested is not available yet.
The underlying favicons package may require network access to download resources (e.g., for rasterizing SVGs)
fixEnsure you have network access or provide a pre-rasterized logo as PNG instead of SVG.
TypeError: ViteFaviconsPlugin is not a function
Incorrect import: using default import when named export is expected, or vice versa
fixUse import { ViteFaviconsPlugin } from 'vite-plugin-favicon' (named export) Error: [vite] Internal server error: FaviconsPlugin(...).apply is not a function
Plugin instantiated without calling it (missing parentheses) or used as Vite plugin incorrectly
fixEnsure you call ViteFaviconsPlugin() as a function in the plugins array
Audit
Dependencies
viterequiredpeer dependency - plugin requires Vite >=2.0.0