Config

Mr.Hope ... 2020-10-22 About 1 min

# showInstall

  • Type: boolean
  • Default: true

Whether display install button when Service Worker is first registered successfully.

# manifest

  • Type: ManifestOption
  • Required: No

You can fill with an object which will be parsed to manifest.webmanifest.

Tips

Some options have their fallback if you donot set them.

  • name: siteConfig.title || themeConfig.title || 'Site'

  • short_name: siteConfig.title || themeConfig.title || 'Site'

  • description: siteConfig.description || themeConfig.description || 'A site built with vuepress-theme-hope'

  • lang: siteConfig.locales['/'].lang || themeConfig.locales['/'].lang || "en-US"

  • start_url: context.base

  • scope: context.base

  • display: "standalone"

  • theme_color: "#46bd87"

  • background_color: '#ffffff'

  • orientation: 'portrait-primary'

  • prefer_related_applications: false

More

For docs of Manifest, please see W3C Manifest (opens new window)

# favicon

  • Type: string
  • Required: No

Path of favico.ico with absolute path.

Note

We recommand you to set favicon for your site

# themeColor

  • 类型: string
  • 默认值: "#46bd87"

Theme Color, default is theme green

# maxSize

  • Type: number
  • Default: 2048

Max size which allows to cache, with KB unit

Note

This option has the highest priority, and any files exceeding this value will be excluded.

So if you generate very large HTML or JS files, please consider increasing this value, otherwise your PWA may not work normally in offline mode.

# cacheHTML

  • Type: boolean
  • Default: true

Whether cache HTML files besides home page and 404 page.

# cachePic

  • Type: boolean
  • Default: false

Whether cache pictures

# maxPicSize

  • Type: number
  • Default: 1024

Max picture size which allows to cache, with KB unit

# apple

Special settings for Apple

If you don’t want to make detailed settings, you can safely ignore it; if you don’t want your site compatable with safari on apple, please set it to false.

# apple.icon

  • Type: string
  • Required: No

Fill in the icon address used by Apple, the recommended size is 152×152

# apple.statusBarColor

  • Type: "black" | "white"
  • Default: "black"

Apple’s status bar color

# apple.maskIcon

  • Type: string
  • Required: No

Safari mask icon

# msTile

Special settings for Microsoft tiles

If you don’t want to make detailed settings, you can safely ignore it; if you don’t want your site compatable with windows, please set it to false.

# msTile.image

  • Type: string
  • Required: No

Tile icon

# msTile.color

  • Type: string
  • Default value: themeColor

The tile color will automatically fall back to themeColor if you don’t set it.

# popupComponent

  • Type: string
  • Default: 'SWUpdatePopup'

You can fill in the custom pop-up component path.

# generateSwConfig

Options passed to workbox-build, for details, see Workbox documentation (opens new window)