faviconManager

Manage website favicon links injection into HTML files during Vite build.

Import Methods

// Submodule import (recommended)
import { faviconManager } from '@meng-xi/vite-plugin/plugins/favicon-manager'

// Barrel import
import { faviconManager } from '@meng-xi/vite-plugin'

Quick Start

import { defineConfig } from 'vite'
import { faviconManager } from '@meng-xi/vite-plugin'

export default defineConfig({
	plugins: [faviconManager({ base: '/assets' })]
})

You can also pass a string as the base path:

export default defineConfig({
	plugins: [faviconManager('/assets')]
})

Options

Option	Type	Default	Description
base	string	'/'	Icon base path
url	string	-	Full icon URL (overrides base + favicon.ico)
link	string	-	Custom link tag HTML (highest priority)
icons	Icon[]	-	Custom icon array
copyOptions	CopyOptions	-	Icon file copy config
enabled	boolean	true	Enable the plugin
verbose	boolean	true	Show detailed logs
errorStrategy	'throw' | 'log' | 'ignore'	'throw'	Error handling strategy

copyOptions

Option	Type	Default	Description
sourceDir	string	Required	Source directory
targetDir	string	Required	Target directory
overwrite	boolean	true	Overwrite existing files
recursive	boolean	true	Recursive copy

Priority

link > icons > url > base + favicon.ico

Examples

Custom Icon Array

faviconManager({
	icons: [
		{ rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' },
		{ rel: 'icon', href: '/favicon-32x32.png', sizes: '32x32', type: 'image/png' },
		{ rel: 'icon', href: '/favicon-16x16.png', sizes: '16x16', type: 'image/png' }
	]
})

Full URL

faviconManager({
	url: 'https://example.com/favicon.ico'
})

Custom Link Tag

faviconManager({
	link: '<link rel="icon" href="/custom.ico" type="image/x-icon">'
})

With File Copy

faviconManager({
	base: '/assets',
	copyOptions: {
		sourceDir: 'src/assets/icons',
		targetDir: 'dist/assets/icons'
	}
})

Full Configuration

faviconManager({
	base: '/assets',
	enabled: true,
	verbose: true,
	copyOptions: {
		sourceDir: 'src/assets/icons',
		targetDir: 'dist/assets/icons',
		overwrite: true,
		recursive: true
	}
})

Notes

• Icon links are injected before the </head> tag
• Skips injection with warning if </head> is not found
• copyOptions uses incremental copy by default
• Incomplete copyOptions throws validation error