Skip to content

Commit 1177cf0

Browse files
committed
docs(pwa): update options
1 parent 36f954b commit 1177cf0

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

packages/@vue/cli-plugin-pwa/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,44 @@ file, or the `"vue"` field in `package.json`.
2929
[`GenerateSW`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_generatesw_config)
3030
or for [`InjectManifest`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_injectmanifest_config).
3131

32+
- **pwa.name**
33+
34+
- Default: "name" field in `package.json`
35+
36+
Used as the value for the `apple-mobile-web-app-title` meta tag in the generated HTML. Note you will need to edit `public/manifest.json` to match this.
37+
38+
- **pwa.themeColor**
39+
40+
- Default: `'#4DBA87'`
41+
42+
- **pwa.msTileColor**
43+
44+
- Default: `'#000000'`
45+
46+
- **pwa.appleMobileWebAppCapable**
47+
48+
- Default: `'no'`
49+
50+
This defaults to `'no'` because iOS before 11.3 does not have proper PWA support. See [this article](https://medium.com/@firt/dont-use-ios-web-app-meta-tag-irresponsibly-in-your-progressive-web-apps-85d70f4438cb) for more details.
51+
52+
- **pwa.appleMobileWebAppStatusBarStyle**
53+
54+
- Default: `'default'`
55+
3256
### Example Configuration
3357

3458
```js
3559
// Inside vue.config.js
3660
module.exports = {
3761
// ...other vue-cli plugin options...
3862
pwa: {
39-
name: 'My App', // used for apple-mobile-web-app-title
63+
name: 'My App',
4064
themeColor: '#4DBA87',
4165
msTileColor: '#000000',
66+
appleMobileWebAppCapable: 'yes',
67+
appleMobileWebAppStatusBarStyle: 'black',
68+
69+
// configure the workbox plugin
4270
workboxPluginMode: 'InjectManifest',
4371
workboxOptions: {
4472
// swSrc is required in InjectManifest mode.

0 commit comments

Comments
 (0)