Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add themeConfig.serviceWorker.updatePopup option (fixes #453) #533

Merged
merged 6 commits into from
Jul 14, 2018

Conversation

mysticatea
Copy link
Member

@mysticatea mysticatea commented May 31, 2018

Summary

Fixes #453.

This PR adds the theme config to show the popup UI which notifies that the cache of the service worker is updated.

This PR includes #462. The #462 adds the functionality to call ServiceWorkerGlobalScope#skipWaiting() from theme's Layout class. Then this PR adds the popup UI to the default theme additionally.

New config is:

module.exports = {
    serviceWorker: true,

    themeConfig: {
        serviceWorker: {
            updatePopup: true || { message: "New content is available.", buttonText: "Refresh" }
        },
    },
}

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

image
The border is $accentColor.

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome 66
  • Firefox 60 - sw-update event didn't notified and Ctrl+F5 activated new service worker.
  • Safari
  • Edge 42 (EdgeHTML 17) - sw-update event didn't notified and Ctrl+F5 activated new service worker.
  • IE - it doesn't support service workers.

If adding a new feature, the PR's description includes:

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@ulivz
Copy link
Member

ulivz commented May 31, 2018

👍

Copy link
Member

@ulivz ulivz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excuse me for the delay to review this PR, Thanks for the super great work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need service worker update alert window.
2 participants