Check if the current application is the latest version. If not, it reminds you to reload the current page.
yarn add @femessage/update-popup
You need to set environment variables UPDATE_POPUP_VERSION
, when iteratively updating, modify the variables greater than current value.
Environment variables
# .env
UPDATE_POPUP_VERSION=1.0.0 # Support more. e.g.: 1.0.0.1, 1.0.0.1.1
Project configuration file
// nuxt.config.js
const config = {
modules: ['@femessage/update-popup/nuxt', {options}],
}
// vue.config.js or poi.config.js
const UpdatePopup = require('@femessage/update-popup')
const config = {
chainWebpack: (config) => {
config.plugin('femessage-update-popup').use(UpdatePopup, [{options}])
},
}
It's so easy.
- Type:
string
- Default:
webpackConfig.output.publicPath
- Reference: webpack publicPath
Use publicPath setting
- Type:
boolean
- Default:
true
Does it need to be automatically added to the webpack entry file?
If set false
Need to manually @femessage/update-popup/app/main
Inject it into your code.
When to set this parameter, see Notice.QianKun。
- Type:
string
- Default:
'UPDATE_POPUP_VERSION'
Key of the environment variable. e.g. process.env.UPDATE_POPUP_VERSION=1.0.0
- Type:
string
- Default:
'update_popup_version.txt'
Version filename.
This plugin automatically generates a common js file and adds it to the webpack entry file,
however, due to the requirement to export lifecycle hooks for the sub-application's entry file.
It is necessary to disable the automatic addition of entry files, with the following adjustments:
Adjust the project configuration file
# nuxt.config.js
const config = {
- modules: ['@femessage/update-popup/nuxt']
+ modules: [['@femessage/update-popup/nuxt'], { inject: false }]
}
# vue.config.js or poi.config.js
const config = {
chainWebpack: config => {
config.plugin('update-popup').use(UpdatePopup, [{
+ inject: false
}])
}
}
Add an entry file in your Sub-application at last
+ import '@femessage/update-popup/app/main'
For those who are interested in contributing to this project, such as:
- report a bug
- request new feature
- fix a bug
- implement a new feature
Please refer to our contributing guide.
Thanks goes to these wonderful people (emoji key):
EVILLT 💻 |
4Ark 📖 🌍 |
This project follows the all-contributors specification. Contributions of any kind welcome!