Skip to content

Latest commit

 

History

History
executable file
·
84 lines (53 loc) · 2.6 KB

README.md

File metadata and controls

executable file
·
84 lines (53 loc) · 2.6 KB
Raw

@vue/cli-plugin-pwa

英文原版

vue-cli 的 pwa 插件

配置

配置是通过 vue.config.js 的 pwa 属性或 package.json 中的 "pwa" 字段处理的。

  • pwa.workboxPluginMode

    这个选项允许你在底层的 workbox-webpack-plugin 所支持的两种模式之间进行选择。

    • 'GenerateSW' (默认值)，每次重新构建你的 web app 时都会创建一个新的 service worker 文件。

    • 'InjectManifest' 允许你以一个现成的 service worker 文件开始，然后创建一份文件拷贝，并把“precache manifest”注入其中。

    这份“该使用哪个插件？”的指南会帮助你在两者之间做出选择。

  • pwa.workboxOptions

    这些选项会传入底层的 workbox-webpack-plugin。

    关于所支持的值的更多的信息，请查阅 GenerateSW 或 InjectManifest 的指南。

  • pwa.name

    • 默认值：package.json 的 "name" 字段

      在生成的 HTML 中用作 apple-mobile-web-app-title meta 标签的值。注意你需要编辑 public/manifest.json 来配合它。

  • pwa.themeColor

    • 默认值：'#4DBA87'

  • pwa.msTileColor

    • 默认值：'#000000'

  • pwa.appleMobileWebAppCapable

    • 默认值：'no'

      这里的默认值是 'no' 因为 iOS 11.3 之前都不支持 PWA。更多详情请查阅这篇文章。

  • pwa.appleMobileWebAppStatusBarStyle

    • 默认值：'default'

配置示例

// Inside vue.config.js
module.exports = {
  // ...其它 vue-cli 插件选项...
  pwa: {
    name: 'My App',
    themeColor: '#4DBA87',
    msTileColor: '#000000',
    appleMobileWebAppCapable: 'yes',
    appleMobileWebAppStatusBarStyle: 'black',

    // 配置 workbox 插件
    workboxPluginMode: 'InjectManifest',
    workboxOptions: {
      // swSrc 中 InjectManifest 模式下是必填的。
      swSrc: 'dev/sw.js',
      // ...其它 Workbox 选项...
    }
  }
}

在已创建的项目中安装

vue add @vue/pwa

注入的 webpack-chain 规则

  • config.plugin('workbox')