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.

Sign up for GitHub

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(workbox): offline analytics #55

Closed
wants to merge 7 commits into from
Closed

feat(workbox): offline analytics #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9f0c7b2
feat: ogSiteName (#50)
TheAlexLichter Apr 2, 2018
bd308ec
feat(worbox): add offline option for making it optional (#59)
gerardo-rodriguez Apr 2, 2018
7cbcde6
feat(workbox): let users enable offline GA tracking
TheAlexLichter Mar 23, 2018
75fd1f6
Merge branch 'develop' into feature-offline-ga
pi0 Aug 24, 2018
7f9c4b1
remove extra line
pi0 Aug 24, 2018
fd10f17
remove removed clientsClaim
pi0 Aug 24, 2018
8e4c530
Merge branch 'dev' into feature-offline-ga
pi0 Sep 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/modules/workbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ workbox: {

**importScripts** (Array) - Additional scripts to be imported in service worker script. (Relative to `/`. Can be placed in `assets/` directory)


**offlineAnalytics** - (Default: false) Enable offline Google Analytics tracking [through workbox](https://developers.google.com/web/tools/workbox/guides/enable-offline-analytics)

**offlineAssets** (String) - List of assets to precache, in case you need extra files precached other than the ones automatically processed (`_nuxt/*` etc) or you want to ensure assets used by your `offlinePage`. (Example: `['/offline.png']`)

**offlinePage** (String) - Enables routing all offline requests to the specified path. (Example: `/offline.html`)
Expand Down
8 changes: 6 additions & 2 deletions packages/workbox/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ function getOptions (moduleOptions) {
routingExtensions: null,
config: null,
cacheId: process.env.npm_package_name || 'nuxt',
clientsClaim: true,
skipWaiting: true,
globPatterns: ['**/*.{js,css}'],
globDirectory: undefined,
Expand All @@ -100,7 +99,8 @@ function getOptions (moduleOptions) {
handler: 'cacheFirst'
}
],
runtimeCaching: []
runtimeCaching: [],
offlineAnalytics: false
}

const options = defaultsDeep({}, this.options.workbox, moduleOptions, defaults)
Expand Down Expand Up @@ -156,6 +156,10 @@ function addTemplates (options) {
skipWaiting: options.skipWaiting,
wbOptions: {
cacheId: options.cacheId,
clientsClaim: options.clientsClaim,
directoryIndex: options.directoryIndex,
},
offlineAnalytics: options.offlineAnalytics
directoryIndex: options.directoryIndex,
cleanUrls: false
}
Expand Down
4 changes: 4 additions & 0 deletions packages/workbox/templates/sw.template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ options.runtimeCaching.forEach(r => {
workbox.routing.registerRoute(new RegExp('<%= r.urlPattern %>'), workbox.strategies.<%= r.handler %>(<%= strategy %>), '<%= r.method %>')
<% }) %>

<% if(options.offlineAnalytics){
workboxSW.googleAnalytics.initialize()
} %>

<% if (options.offlinePage) { %>
// offlinePage support
const strategy = workbox.strategies.networkOnly()
Expand Down