@pwabuilder/pwainstall - npm Package Compare versions

Comparing version 0.9.8 to 0.9.9

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +0,0 @@ ---

CONTRIBUTING.md

@@ -0,0 +0,0 @@ # Contributing to the pwa-install component

LICENSE.txt

@@ -0,0 +0,0 @@ ManifoldJS

package.json

 {
   "name": "@pwabuilder/pwainstall",
-  "version": "0.9.8",
+  "version": "0.9.9",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/pwa-install.js",

README.md

@@ -39,8 +39,9 @@ # pwa-install
 
-| Property       | Attribute      | Description                     | Type      | Default         |
-| -------------- | -------------- | ------------------------------- | --------- | --------------- |
-| `showopen`     | `showopen`     | Will always show install button | `boolean` | `false`         |
-| `manifestpath` | `manifestpath` | path to your web manifest       | `string`  | `manifest.json` |
-| `featuresheader`     | `featuresheader`     | Controls the text of the features header | `string` | `Key Features`         |
-| `descriptionheader` | `descriptionheader` | Controls the text of the description header       | `string`  | `Description` |
+| Property            | Attribute           | Description                                       | Type      | Default         |
+| ------------------- | ------------------- | ------------------------------------------------- | --------- | --------------- |
+| `showopen`          | `showopen`          | Will always show install button                   | `boolean` | `false`         |
+| `showeligible`      | `showeligible`      | Will only show install button if user is eligible | `boolean` | `false`         |
+| `manifestpath`      | `manifestpath`      | path to your web manifest                         | `string`  | `manifest.json` |
+| `featuresheader`    | `featuresheader`    | Controls the text of the features header          | `string`  | `Key Features`  |
+| `descriptionheader` | `descriptionheader` | Controls the text of the description header       | `string`  | `Description`   |
 
@@ -47,0 +48,0 @@ ### Methods

rollup.config.js

@@ -0,0 +0,0 @@

src/pwa-install.ts

@@ -16,2 +16,5 @@ import {
   @property({ type: Boolean }) showopen: boolean;
+  @property({ type: Boolean }) showEligible: boolean;
+  @property({ type: Boolean }) isSupportingBrowser: boolean;
+  @property({ type: Boolean }) isIOS: boolean;
   @property() explainer: string = "This app can be installed on your PC or mobile device.  This will allow this web app to look and behave like any other installed up.  You will find it in your app lists and be able to pin it to your home screen, start menus or task bars.  This installed web app will also be able to safely interact with other apps and your operating system. "
@@ -287,2 +290,9 @@ @property() featuresheader: string = "Key Features";
 
+    #iosText {
+      color: var(--install-button-color);
+      margin: 2em;
+      text-align: center;
+      font-weight: bold;
+    }
+
       @media(min-width: 1445px) {
@@ -426,2 +436,8 @@ #installModal {
 
+    // handle iOS specifically
+    this.isIOS = navigator.userAgent.includes('iPhone');
+
+    // check for beforeinstallprompt support
+    this.isSupportingBrowser = window.hasOwnProperty('BeforeInstallPromptEvent');
+
     document.onkeyup = (e) => {
@@ -476,2 +492,7 @@ if (e.key === "Escape") {
 
+  shouldShowInstall(): boolean {
+    const eligibleUser = this.showEligible && this.isSupportingBrowser && this.deferredprompt;
+    return this.showopen || eligibleUser;
+  }
+
   public async install(): Promise<boolean> {
@@ -506,3 +527,3 @@ if (this.deferredprompt) {
     return html`
-      ${this.showopen ? html`<button id="openButton" @click="${() => this.openPrompt()}">
+      ${this.shouldShowInstall() ? html`<button id="openButton" @click="${() => this.openPrompt()}">
         <slot>
@@ -579,6 +600,6 @@ Install
 
-        <div id="buttonsContainer">
+        ${!this.isIOS ? html`<div id="buttonsContainer">
           ${this.deferredprompt ? html`<button id="installButton" @click="${() => this.install()}">Install ${this.manifestdata.short_name}</button>` : html`<button @click="${() => this.cancel()}" id="installButton">Close</button>`}
         </div>
-          </div>
+          </div>` : html`<p id="iosText">Tap the share button and then 'Add to Homescreen'</p>`}
         `
@@ -585,0 +606,0 @@ : null

tsconfig.json

@@ -0,0 +0,0 @@ {

www/manifest-invalid.json

@@ -0,0 +0,0 @@ {

www/manifest-lesser.json

@@ -0,0 +0,0 @@ {

www/manifest.json

@@ -0,0 +0,0 @@ {

www/service-worker.js

@@ -0,0 +0,0 @@ // This is the service worker with the Cache-first network

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

474191

increased by0.35%

Lines of code

1544

increased by1.38%

Number of lines in readme file

61

increased by1.67%

No dependency changes