@wireninja/vite-plugin-laravel-pwa

Opinionated Laravel defaults for vite-plugin-pwa.

Install

npm install -D @wireninja/vite-plugin-laravel-pwa vite-plugin-pwa

For Bun projects:

bun add -d @wireninja/vite-plugin-laravel-pwa vite-plugin-pwa

Prepare Source Icon

Create a square SVG icon at:

public/favicon.svg

Use a clean, centered logo with enough padding for maskable icons. The default CLI reads this file and generates all standard public PWA icons.

Generate Icons

npx laravel-pwa icons

This generates:

public/favicon.ico
public/pwa-64x64.png
public/pwa-192x192.png
public/pwa-512x512.png
public/maskable-icon-512x512.png
public/apple-touch-icon-180x180.png

To use another source SVG:

npx laravel-pwa icons --source=public/logo.svg --preset=minimal

Usage

import { defineConfig } from 'vite';
import { laravelPwa } from '@wireninja/vite-plugin-laravel-pwa';

export default defineConfig({
    plugins: [
        laravelPwa({
            name: 'Waringin Sukses Sejati',
            shortName: 'WSS',
            description: 'ERP Waringin Sukses Sejati',
            themeColor: '#DE9918',
        }),
    ],
});

Required Values

• name
• shortName
• description
• themeColor

backgroundColor defaults to themeColor.

Optional Values

• backgroundColor
• registerType
• startUrl
• scope
• id
• orientation
• display
• icons
• publicAssets
• additionalImages
• navigateFallback
• navigateFallbackDenylist
• maximumFileSizeToCacheInBytes
• warnOnMissingAssets
• manifest
• pwa

Defaults

The plugin configures Laravel-friendly defaults:

• build output remains in public
• service worker scope is /
• generated PWA assets in public are included in the manifest and precache
• public/storage/**, vendor/**, hot, and .git/** are ignored by Workbox
• includeAssets is empty to avoid Laravel public directory path issues
• public asset revisions use file hashes instead of Date.now()