# Vite Plugin: Favicon Generator

Een wrijvingsloze Vite-plugin die alle favicons, app-pictogrammen en manifestbestanden genereert vanuit één bronafbeelding. Het injecteert automatisch HTML-tags bij het bouwen, serveert pictogrammen tijdens de ontwikkeling en is volledig configureerbaar (paden, pictogrammensets, manifesten).

- URL: https://isapp.be/vite-plugin-favicon-generator
- Published: 2025-09-26
- Updated: 2025-09-26
- Other languages: [en](https://isapp.be/en/vite-plugin-favicon-generator.md), [fr](https://isapp.be/fr/vite-plugin-generateur-de-favicon.md)

# Vite Plugin: Favicon generator

![Vite Plugin: Favicon Generator](https://static.isap.me/vite-plugin-favicon-generator.png "vite-plugin-favicon-generator")

Een Vite plugin die automatisch favicons genereert van een bronafbeelding met behulp van de krachtige [favicons](https://github.com/itgalaxy/favicons) bibliotheek.

## Kenmerken

- genereer meerdere favicon formaten van een enkele bronafbeelding
- 🔧 Volledig configureerbare favicon opties
- 🚀 Automatische HTML injectie in `index.html`
- 📁 Aangepaste uitvoermap en openbaar pad
- 🔄 Ondersteuning voor ontwikkelingsserver met in-memory serving
- 📝 Optioneel genereren van HTML-tags bestand
- 🎨 Ondersteuning voor Android, Apple en standaard favicons

## Installatie

```bash
npm install vite-plugin-favicon-generator --save-dev
# or
yarn add vite-plugin-favicon-generator --dev
# or
pnpm add vite-plugin-favicon-generator --save-dev

```

## Gebruik

### Basis gebruik

```js
// vite.config.js
import { defineConfig } from 'vite'
import faviconPlugin from 'vite-plugin-favicon-generator'

export default defineConfig({
  plugins: [
    faviconPlugin({
      source: 'src/assets/favicon.png', // Source favicon image
      appName: 'My App',
      theme_color: '#1a1065',
      background: '#ffffff',
    })
  ]
})

```

### Geavanceerde configuratie

```js
// vite.config.js
import { defineConfig } from 'vite'
import faviconPlugin from 'vite-plugin-favicon-generator'

export default defineConfig({
  plugins: [
    faviconPlugin({
      // Source image
      source: 'src/assets/favicon.png',
      
      // Output configuration
      outputDir: 'icons', // Output directory (relative to dist)
      publicPath: '/icons', // Public path for HTML links
      htmlOutput: 'src/favicon-tags.html', // Generate HTML tags file
      injectHtml: true, // Auto-inject into index.html
      
      // Favicon configuration (same as favicons library)
      appName: 'My Awesome App',
      appShortName: 'MyApp',
      appDescription: 'My awesome application description',
      developerName: 'Your Name',
      developerURL: 'https://yoursite.com',
      lang: 'en-US',
      theme_color: '#1a1065',
      background: '#ffffff',
      
      // Icon types to generate
      icons: {
        android: true,              // Android homescreen icon
        appleIcon: true,           // Apple touch icons
        appleStartup: false,       // Apple startup images
        favicons: true,            // Regular favicons
        windows: false,            // Windows 8 tile icons
        yandex: false,             // Yandex browser icon
      },
      
      // Platform-specific options
      android: {
        offset: 10,
        background: '#ffffff'
      },
      appleIcon: {
        offset: 10,
        background: '#ffffff'
      }
    })
  ]
})

```

## Configuratie Opties

### Plugin opties

| Optie | Type | Standaard | Beschrijving |
|---|---|---|---|
| `source` | `string` | `'src/favicon.png'` | Pad naar de bron favicon afbeelding |
| `outputDir` | `string` | `'favicons'` | Uitvoermap voor gegenereerde favicons (relatief ten opzichte van build uitvoer) |
| `publicPath` | `string` | `'/favicons'` | Publiek pad voor favicons in HTML |
| `htmlOutput` | `string` | `undefined` | Uitvoerbestand voor HTML-tags (relatief ten opzichte van project root) |
| `injectHtml` | `boolean` | `true` | Of HTML-tags in index.html moeten worden geïnjecteerd |

### Favicon opties

Alle opties uit de [favicons bibliotheek](https://github.com/itgalaxy/favicons#usage) worden ondersteund:

| Optie | Type | Standaard | Beschrijving |
|---|---|---|---|
| `appName` | `string` | `null` | Naam van je applicatie |
| `appShortName` | `string` | `appName` | De korte naam van je applicatie |
| `appDescription` | `string` | `null` | De beschrijving van je applicatie |
| `developerName` | `string` | `null` | Jouw naam |
| `developerURL` | `string` | `null` | Jouw website |
| `lang` | `string` | `'en-US'` | Primaire taal voor naam en korte\_naam |
| `background` | `string` | `'#fff'` | Achtergrondkleur voor afgevlakte pictogrammen |
| `theme_color` | `string` | `'#fff'` | Themakleur die gebruikersagenten moeten gebruiken |
| `icons` | `object` | Zie hieronder | Platform-specifieke pictogram instellingen |

### Pictogram Configuratie

```js
icons: {
  android: true,              // Create Android homescreen icon
  appleIcon: true,           // Create Apple touch icons  
  appleStartup: false,       // Create Apple startup images
  favicons: true,            // Create regular favicons
  windows: false,            // Create Windows 8 tile icons
  yandex: false,             // Create Yandex browser icon
}

```

Elk pictogramtype kan ook een object met `offset` en `background` eigenschappen accepteren:

```js
icons: {
  android: {
    offset: 10,
    background: '#ffffff'
  },
  appleIcon: {
    offset: 15,
    background: 'transparent'
  }
}

```

## Voorbeelden

### React + TypeScript

```ts
// vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import faviconPlugin from 'vite-plugin-favicon-generator'

export default defineConfig({
  plugins: [
    react(),
    faviconPlugin({
      source: 'src/assets/logo.png',
      appName: 'React App',
      appDescription: 'My React application',
      theme_color: '#646cff',
      background: '#ffffff',
      icons: {
        android: true,
        appleIcon: true,
        favicons: true,
      }
    })
  ]
})

```

### Vue.js

```js
// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import faviconPlugin from 'vite-plugin-favicon-generator'

export default defineConfig({
  plugins: [
    vue(),
    faviconPlugin({
      source: 'src/assets/favicon.png',
      appName: 'Vue App',
      theme_color: '#4fc08d',
      background: '#ffffff',
    })
  ]
})

```

### Laravel

```js
// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import faviconPlugin from 'vite-plugin-favicon-generator'

export default defineConfig({
  plugins: [
    laravel(),
    faviconPlugin({
        source: 'resources/images/favicon.png',
        outputDir: 'public/favicons',
        publicPath: '/favicons',
        htmlOutput: 'resources/views/favicons.blade.php',
        injectHtml: false,
        icons: {
            android: true,
            appleIcon: true,
            appleStartup: false,
            favicons: true,
            windows: false,
            yandex: false,
        },
    })
  ]
})

```

```blade
{{-- layout.blade.php --}}
@if(file_exists(resource_path('views/favicons.blade.php')))
    @include('favicons')
@endif

```

### Aangepaste uitvoer en HTML-generatie

```js
faviconPlugin({
  source: 'assets/icon.png',
  outputDir: 'static/icons',
  publicPath: '/static/icons',
  htmlOutput: 'public/favicon-meta.html',
  injectHtml: false, // Don't auto-inject, use the HTML file instead
  appName: 'My Custom App',
})

```

## Ontwikkeling vs Productie

- **Ontwikkeling**: Favicons worden in het geheugen gegenereerd en geserveerd via middleware
- **Productie**: Favicons worden gegenereerd als statische bestanden in de build output directory

## Vereisten

- Node.js &gt;= 18
- Vite &gt;= 5.0.0

## Bijdragen

Gelieve bugs of feature requests in te dienen via de [Github issues](https://github.com/isap-ou/vite-plugin-favicon-generator/issues).

Pull requests zijn welkom!

Bedankt!

## Licentie

Dit project is open-sourced software gelicenseerd onder de [MIT Licentie](https://opensource.org/licenses/MIT).

Je bent vrij om het te gebruiken, aan te passen en te verspreiden in je projecten, zolang je voldoet aan de voorwaarden van de licentie.
