mirror of
https://github.com/CharaChorder/DeviceManager.git
synced 2026-01-19 00:13:01 +00:00
91 lines
3.4 KiB
Markdown
91 lines
3.4 KiB
Markdown
<p align='center'>
|
|
<img src='./hero.png' alt="@vite-pwa/sveltekit - Zero-config PWA for SvelteKit"><br>
|
|
Zero-config PWA Plugin for SvelteKit
|
|
</p>
|
|
|
|
<p align='center'>
|
|
<a href='https://www.npmjs.com/package/@vite-pwa/sveltekit' target="__blank">
|
|
<img src='https://img.shields.io/npm/v/@vite-pwa/sveltekit?color=33A6B8&label=' alt="NPM version">
|
|
</a>
|
|
<a href="https://www.npmjs.com/package/@vite-pwa/sveltekit" target="__blank">
|
|
<img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/sveltekit?color=476582&label=">
|
|
</a>
|
|
<a href="https://vite-pwa-org.netlify.app/frameworks/sveltekit" target="__blank">
|
|
<img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
|
|
</a>
|
|
<br>
|
|
<a href="https://github.com/vite-pwa/sveltekit" target="__blank">
|
|
<img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/sveltekit?style=social">
|
|
</a>
|
|
</p>
|
|
|
|
<br>
|
|
|
|
<p align="center">
|
|
<a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
|
|
<img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
|
|
</a>
|
|
</p>
|
|
|
|
|
|
## 🚀 Features
|
|
|
|
- 📖 [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
|
|
- 👌 **Zero-Config**: sensible built-in default configs for common use cases
|
|
- 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin
|
|
- 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)
|
|
- 🔌 **Offline Support**: generate service worker with offline support (via Workbox)
|
|
- ⚡ **Fully tree shakable**: auto inject Web App Manifest
|
|
- 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
|
|
- ⚙️ **Stale-while-revalidate**: automatic reload when new content is available
|
|
- ✨ **Static assets handling**: configure static assets for offline support
|
|
- 🐞 **Development Support**: debug your custom service worker logic as you develop your application
|
|
- 🛠️ **Versatile**: integration with meta frameworks: [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), and [Nuxt 3](https://github.com/nuxt/nuxt)
|
|
- 💥 PWA Assets Generator: generate all the PWA assets from a single command and a single source image
|
|
|
|
## 📦 Install
|
|
|
|
> From v0.2.0, `@vite-pwa/sveltekit` requires **SvelteKit 1.3.1 or above**.
|
|
|
|
```bash
|
|
npm i @vite-pwa/sveltekit -D
|
|
|
|
# yarn
|
|
yarn add @vite-pwa/sveltekit -D
|
|
|
|
# pnpm
|
|
pnpm add @vite-pwa/sveltekit -D
|
|
```
|
|
|
|
## 🦄 Usage
|
|
|
|
Add `SvelteKitPWA` plugin to `vite.config.js / vite.config.ts` and configure it:
|
|
|
|
```ts
|
|
// vite.config.js / vite.config.ts
|
|
import { sveltekit } from '@sveltejs/kit/vite'
|
|
import { SvelteKitPWA } from '@vite-pwa/sveltekit'
|
|
|
|
export default {
|
|
plugins: [
|
|
sveltekit(),
|
|
SvelteKitPWA()
|
|
]
|
|
}
|
|
```
|
|
|
|
Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/sveltekit) for a complete guide on how to configure and use
|
|
this plugin.
|
|
|
|
## 👀 Full config
|
|
|
|
Check out the type declaration [src/types.ts](./src/types.ts) and the following links for more details.
|
|
|
|
- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
|
|
- [Workbox](https://developers.google.com/web/tools/workbox)
|
|
|
|
|
|
## 📄 License
|
|
|
|
[MIT](./LICENSE) License © 2022-PRESENT [Anthony Fu](https://github.com/antfu)
|