antfu/vite-plugin-pwa
Vite Plugin Pwa
This project is a Vite plugin that transforms web applications into Progressive Web Apps by automating the generation of service workers and web app manifests. It provides a suite of pipelines and generators designed to enable device installation, offline functionality, and automated asset management.
The plugin features a dedicated asset pipeline that generates a complete set of required application icons and splash screens from a single source image. It also includes a state manager that uses reactive primitives to synchronize service worker registration and update status with the application user interface.
Broad capability areas include automated service worker registration and compilation, cache storage management for offline access, and the injection of manifest links and theme color meta tags into the HTML entry point. The tool also handles update workflows by detecting new content in the background and prompting users to refresh the page.
Development tools allow for the execution and debugging of service worker logic during the active development process without requiring a production build.
Features
- Progressive Web Apps - Transforms Vite web applications into installable Progressive Web Apps with offline capabilities.
- PWA Plugins - Transforms Vite applications into Progressive Web Apps by automating service worker and manifest generation.
- Asset Resource Generators - Provides automated generation of platform-specific icons and splash screens from a single source image during the build process.
- PWA Image Pipelines - Provides a workflow for generating a complete set of required application icons and splash screens from a single source image.
- PWA Development Toolkits - Offers an integrated toolkit for generating and serving the required PWA assets from a single image source.
- Service Worker Lifecycle Managers - Manages the registration, activation, and update lifecycle of service workers to ensure application stability.
- Service Worker Generators - Provides a build-time system for generating service worker files and injecting precache manifests to enable offline functionality.
- Service Worker Bundlers - Compiles custom service worker logic and injects a build manifest for precise asset caching and versioning.
- Offline Web Caching - Implements asset caching and background synchronization to allow the web application to work without an internet connection.
- PWA Configuration Tooling - Provides utilities for automating the generation and injection of app icons and splash screens into the project.
- PWA Manifest Generators - Generates the web app manifest file required to map assets and enable device installation.
- Web App Manifests - Embeds the required manifest file and metadata into the application to support native-like installation.
- Service Worker Debugging Tools - Allows developers to test and refine custom service worker logic during the active development process.
- Service Worker Development Environments - Runs service worker logic during development to verify application behavior and routing without a production build.
- Browser Update Notifications - Triggers browser notifications when a new service worker is available or the app is ready for offline use.
- Virtual Modules - Creates synthetic modules at build time to provide PWA configuration and registration logic to the application code.
- Icon Generators - Creates a complete set of required application icons from a single source image via a command line.
- PWA State Synchronization - Provides reactive primitives for syncing service worker registration and update status with the application user interface.
- State Synchronization Primitives - Synchronizes service worker registration and update status using reactive state primitives to keep the UI current.
- PWA Meta Tag Injection - Automatically inserts web manifest links and theme color tags into the application entry point during the build.
- Update Reload Prompts - Detects new content in the background and prompts the user to reload the page to apply updates.
- Service Worker Controls - Manages service worker registration and update cycles via virtual modules to maintain application stability.
- Cache Management - Implements logic to delete outdated assets from the browser cache during application updates.
- Automatic Registration Scripts - Creates the necessary scripts to automate service worker registration in the browser.
- PWA Update Notifications - Detects new application versions in the background and prompts users to refresh the page to apply updates.
- Reactive State Synchronization - Uses shared reactive primitives to synchronize service worker registration and update status with the user interface.
- Framework Integrations - Zero-configuration Progressive Web App support.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
