alQlagin / ngx-pwa-install

1 stars 0 forks source link

NgxPwaInstall

Small wrapper with allows handle beforeinstallprompt event in angular way

Demo available here

Install

Install from npm

npm install ngx-pwa-install

and connect to main module to setup listeners

@Component({
    imports: [NgxPwaInstallModule.forRoot()]
})
class AppModule {}

After installed module prevents default process of BeforeInstallPromptEvent

Usage

To display custom PWA install popup wrap it with <ngx-pwa-install></ngx-pwa-install>

To proceed install request use .install() method of component

Positioning of install panel is your choice. Component does not add any css or block elements

<ngx-pwa-install #pwa>
    <div class="pwa-install-panel" (click)="pwa.install()">
       Click to install
    </div>
</ngx-pwa-install>

To handle when your content will be shown use prompt output. This may be useful for animation state

<ngx-pwa-install #pwa (prompt)="showPanel=true">
    <div [@animatePanel]="showPanel" class="pwa-install-panel" (click)="pwa.install()">
       Click to install
    </div>
</ngx-pwa-install>

To import only component outside of root module import module without .forRoot()

@Component({
    imports: [NgxPwaInstallModule]
})
class FeatureModule {}