Package Health Score

65 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.6.1	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.5.0	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (11,213)

GitHub Stars: 9
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package pwa-install-handler receives a total of 11,213 downloads a week. As such, we scored pwa-install-handler popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package pwa-install-handler, we found that it has been starred 9 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like pwa-install-handler is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 3
Open PR: 2
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of pwa-install-handler based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that pwa-install-handler demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 0 Direct
Versions: 22
Install Size: 25.6 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: Yes

pwa-install-handler has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

PWA install handler

Handling PWA installation prompt made easier. MDN docs

Installation

npm install pwa-install-handler

Usage

HTML

<button style="display: none;" id="installButton">Install</button>

JavaScript

import { pwaInstallHandler } from 'pwa-install-handler'

const $button = document.querySelector('#installButton')

pwaInstallHandler.addListener((canInstall) =&gt; {
	$button.style.display = canInstall ? 'inline-block' : 'none'
})

$button.addEventListener('click', () =&gt; {
	pwaInstallHandler.install()
})

React

For more information see react-use-pwa-install.

Screencast

UI example

Demo

Check website or code.

Methods

pwaInstallHandler.install: () =&gt; Promise

pwaInstallHandler.addListener: (
	(
		callback: (canInstall: boolean) =&gt; void,
		install?: () =&gt; Promise
	) =&gt; void
) =&gt; void

pwaInstallHandler.removeListener: (
	(
		callback: (canInstall: boolean) =&gt; void,
		install?: () =&gt; Promise
	) =&gt; void
) =&gt; void

pwaInstallHandler.canInstall: () =&gt; boolean

pwaInstallHandler.getEvent: () =&gt; BeforeInstallPromptEvent | null

Notes

You PWA must meet some requirements to be installable. Without that the canInstall will always be false. The requirements are browser specific. You can read more about it here (MDN) and here (web.dev).

Some browsers don't support custom install button. These will have canInstall always set to false too. For more information check BeforeInstallPromptEvent support.

pwa-install-handler development dependencies

@rollup/plugin-commonjs @rollup/plugin-node-resolve @rollup/plugin-typescript prettier rollup rollup-plugin-delete rollup-plugin-peer-deps-external rollup-plugin-typescript2 serve typescript

FAQs

What is pwa-install-handler?

Handle beforeinstallprompt event in your PWA. Visit Snyk Advisor to see a full health score report for pwa-install-handler, including popularity, security, maintenance & community analysis.

Is pwa-install-handler popular?

The npm package pwa-install-handler receives a total of 11,213 weekly downloads. As such, pwa-install-handler popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pwa-install-handler well maintained?

We found indications that pwa-install-handler maintenance is sustainable demonstrating some project activity. We saw a total of 1 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is pwa-install-handler safe to use?

The npm package pwa-install-handler was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 11 November-2024, at 23:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP