vue-screenfull 1.0.4 → 1.0.6

package/README.md

@@ -9,7 +9,7 @@
 [license-url]: https://github.com/chengchuu/vue-screenfull/blob/main/LICENSE
 
 Reactive, strongly typed, SSR-safe fullscreen utilities designed for Vue 3.
-The library uses the browser Fullscreen API when available and can optionally provide an explicitly labelled CSS pseudo-fullscreen fallback.
+An optional CSS pseudo-fullscreen fallback is also available.
 
 - [Project website](https://chengchuu.github.io/vue-screenfull/)
 - [Live playground](https://chengchuu.github.io/vue-screenfull/playground/)
@@ -351,6 +351,25 @@ npm run dev
 
 Native fullscreen automation is intentionally not treated as universally reliable because browsers enforce user activation.
 
+## Installable Documentation Website
+
+The project website is a Progressive Web App scoped to `/vue-screenfull/`. Its homepage,
+playground, and API documentation share a generated manifest and a Google Workbox v7 service
+worker. Documents, scripts, and styles use bounded network-first caches so current documentation
+normally wins without pairing fresh HTML with stale bundles; local images and fonts use bounded
+cache-first storage. A precached offline page is used only when a requested document is unavailable
+from both the network and runtime cache.
+
+Installation uses the browser's native `beforeinstallprompt` flow when available. The site never
+opens that prompt automatically, and browsers without a custom prompt can use their menu or, on
+iOS/iPadOS Safari, **Share → Add to Home Screen**. Installing this website is separate from the
+Fullscreen API and does not grant fullscreen capability.
+
+Worker updates remain user-controlled. When a new version is waiting, choose **Update now** to
+activate it and reload the current page once. On the playground, this explicit action is the only
+update path that reloads an active session. The generated worker includes a final-artifact version
+marker, so deployable website changes can be detected without precaching unversioned bundles.
+
 ## Development
 
 Node.js 22 is used in CI.
@@ -364,10 +383,14 @@ npm run test
 npm run build
 npm run docs
 npm run seo:validate
+npm run pwa:validate
 npm run preview
 npm pack --dry-run
 ```
 
+Normal `npm run dev` does not register the production worker. Build `npm run docs` and serve the
+generated `docs` directory from localhost under `/vue-screenfull/` for production-like PWA testing.
+
 See `MANUAL_TESTING.md` for the browser matrix and real-browser strategy.
 Production output remains `lib/index.cjs.js`, `lib/index.esm.js`, `lib/vue-screenfull.min.js`, `lib/index.d.ts`, `lib/typing.d.ts`, and `lib/global.d.ts`. Native Node ESM resolves through the additional conditional entry `lib/index.mjs`.
 

package/lib/index.cjs.js

@@ -1,5 +1,5 @@
 /*!
- * vue-screenfull v1.0.4
+ * vue-screenfull v1.0.6
  * (c) 2018-2026 Cheng https://www.npmjs.com/package/vue-screenfull
  * Released under the MIT License.
  */

package/lib/index.esm.js

@@ -1,5 +1,5 @@
 /*!
- * vue-screenfull v1.0.4
+ * vue-screenfull v1.0.6
  * (c) 2018-2026 Cheng https://www.npmjs.com/package/vue-screenfull
  * Released under the MIT License.
  */

package/lib/index.mjs

@@ -1,5 +1,5 @@
 /*!
- * vue-screenfull v1.0.4
+ * vue-screenfull v1.0.6
  * (c) 2018-2026 Cheng https://www.npmjs.com/package/vue-screenfull
  * Released under the MIT License.
  */

package/lib/vue-screenfull.min.js

@@ -1,5 +1,5 @@
 /*!
- * vue-screenfull v1.0.4
+ * vue-screenfull v1.0.6
  * (c) 2018-2026 Cheng https://www.npmjs.com/package/vue-screenfull
  * Released under the MIT License.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-screenfull",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Reactive, strongly typed, SSR-safe fullscreen utilities for Vue 3.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
@@ -28,17 +28,17 @@
   ],
   "scripts": {
     "dev": "webpack serve --config ./scripts/webpack.config.dev.js",
-    "dev:open": "webpack serve --config ./scripts/webpack.config.dev.js --open",
     "build": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=close SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
     "build:debug": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=open SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
     "build:dev": "webpack --config ./scripts/webpack.config.dev.js",
-    "build:playground": "webpack --mode production --config ./scripts/webpack.config.dev.js",
+    "build:playground": "cross-env GITHUB_PAGES=true webpack --mode production --config ./scripts/webpack.config.dev.js",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "typecheck": "tsc --noEmit",
-    "docs": "typedoc --out ./docs/api --readme ./README.md --excludeProtected --excludePrivate --excludeInternal --hideGenerator && npm run build:playground && node scripts/build-pages.js && npm run seo:validate",
+    "docs": "typedoc --out ./docs/api --readme ./README.md --excludeProtected --excludePrivate --excludeInternal --hideGenerator && npm run build:playground && node scripts/build-pages.js && npm run seo:validate && npm run pwa:validate",
     "seo:validate": "node scripts/validate-seo.js",
-    "lint": "eslint ./examples ./scripts ./site/*.js ./src ./test ./types",
+    "pwa:validate": "node scripts/validate-pwa.js",
+    "lint": "eslint ./examples ./scripts ./site ./src ./test ./types",
     "lint:fix": "npm run lint -- --fix",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
@@ -101,7 +101,16 @@
     "vue": "^3.5.24",
     "webpack": "^5.108.4",
     "webpack-cli": "^7.2.1",
-    "webpack-dev-server": "^6.0.0"
+    "webpack-dev-server": "^6.0.0",
+    "workbox-build": "^7.4.1",
+    "workbox-cacheable-response": "^7.4.1",
+    "workbox-core": "^7.4.1",
+    "workbox-expiration": "^7.4.1",
+    "workbox-navigation-preload": "^7.4.1",
+    "workbox-precaching": "^7.4.1",
+    "workbox-routing": "^7.4.1",
+    "workbox-strategies": "^7.4.1",
+    "workbox-window": "^7.4.1"
   },
   "peerDependencies": {
     "vue": "^3.3.0"