Skip to content

ResolvedPWAAssetsOptions ​

Interface unplugin-pwa-core

Properties ​

PropertyTypeDefaultDescription
configstring | booleanfalsePWA assets generation and injection.

By default, the plugin will search for the pwa assets generator configuration file in the root directory of your project:
- pwa-assets.config.js
- pwa-assets.config.mjs
- pwa-assets.config.cjs
- pwa-assets.config.ts
- pwa-assets.config.cts
- pwa-assets.config.mts

If using a string path, it should be relative to the root directory of your project.

Setting to false will disable config resolving.

WARNING: You can use only one image in the configuration file.
disabledboolean
htmlPresetHtmlLinkPreset'2023'The preset to use for head links (favicon links).

If the config option is enabled, this option will be ignored.
imagesstring[]
includeHtmlHeadLinksbooleantrueShould the plugin include html head links?
injectThemeColorbooleantrueShould the PWA web manifest theme_color be injected in the html head?
integration?PWAAssetsIntegrationOptions
overrideManifestIconsbooleanfalseShould the plugin override the PWA web manifest icons' entry?

The plugin will auto-detect the icons from the manifest, if missing, then the plugin will ignore this option and will include the icons.
presetfalse | BuiltInPreset | Preset'minimal-2023'Preset to use.

If the config option is enabled, this option will be ignored.

Setting this option false will disable PWA assets generation (if the config option is also disabled).

Released under the MIT License.