react-ios-pwa-prompt

v2.0.6

A React component to prompt the user to add the app as a PWA to the home screen with native iOS styles. For more information about how to use this package see README

Latest version published 4 months ago

License: Unknown

NPM

GitHub

Package Health Score

63 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.6	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.4	\|	11/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.0	\|	03/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.0	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.5.1	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unknown

Unable to detect license

We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.

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

Small

Weekly Downloads (2,762)

GitHub Stars: 175
Forks: 41
Contributors: 8

Direct Usage Popularity

The npm package react-ios-pwa-prompt receives a total of 2,762 downloads a week. As such, we scored react-ios-pwa-prompt popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package react-ios-pwa-prompt, we found that it has been starred 175 times.

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

Community

Sustainable

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

This project has seen only 10 or less contributors.

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

How about a good first contribution to this project? It seems that react-ios-pwa-prompt is missing a LICENSE file.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 11
Open PR: 22
Last Release: 4 months ago
Last Commit: 4 months ago

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

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

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: 5 years
Dependencies: 0 Direct
Versions: 28
Install Size: 28.1 kB
Dist-tags: 1
# of Files: 71
Maintainers: 1
TS Typings: No

react-ios-pwa-prompt 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

React-iOS-PWA-prompt

Gzip file size

> Polyfilling PWAs for iOS

A React component that provides a customisable Progressive Web App (PWA) prompt telling the user to 'Add to Home Screen'. The prompt behaviour is baked in to Android devices, yet iOS is still lagging behind. This component aims to provide a simple way to provide this functionality on iOS for websites that are PWA-ready. The prompt styles closely match iOS designs for both light and dark UI modes to appear native to the user.

Features

🛠 Fully configurable, set how many times you want to see it, and after how many page visits.
📃 PWA available offline? In full screen mode? Customise the content of your prompts message through props.
⚡️ Efficient. Very little overhead for non-iOS devices and does as little work as needed for each page load.
🌕 Light & dark mode available depending on user's settings.

Usage

Add react-ios-pwa-prompt as a dependency using pnpm add react-ios-pwa-prompt.
Import into your project:

import PWAPrompt from 'react-ios-pwa-prompt'

Render the component:

Add optional props to configure:

Prop	Description	Default Value
timesToShow	Number of consecutive visits to show the prompt	2
promptOnVisit	On which visit should the first prompt be shown?	2
delay	Pass an integer in ms to add a delay to the prompt	1000
onClose	Callback function for once the prompt is dismisseed	() => undefined
copyTitle	The title of the prompt	Add to Home Screen
copySubtitle	The subtitle of the prompt	String(window.location.href)
copyDescription	The description of the prompt	This website has app functionality. Add it to your home screen to use it in fullscreen and while offline.
copyShareStep	The Share button copy	Press the 'Share' button on the menu bar below
copyAddToHomescreenStep	The Add To Homescreen button copy	Press 'Add to Home Screen'
appIconPath	Path to an icon or favicon to be shown as the app icon	`https://s2.googleusercontent.com/s2/favicons?domain=${window.location.origin}`
isShown	Can be set to true to manually show the prompt	undefined

Create your own trigger rules You can easily set your own trigger conditions if you don't like the consecutive page loads approach. For example:

const [shouldShowPWAPrompt, setShouldShowPWAPrompt] = useState(false)

useEffect(() =&gt; {
    // 20% chance of popping up
    setShouldShowPWAPrompt(Math.random() &lt; 0.2)
}, [])

return (
    
)

react-ios-pwa-prompt development dependencies

@types/node @types/react @types/react-dom @typescript-eslint/eslint-plugin @typescript-eslint/parser @vitejs/plugin-react eslint eslint-plugin-react-hooks eslint-plugin-react-refresh glob react react-dom typescript vite vite-plugin-dts vite-plugin-lib-inject-css

FAQs

What is react-ios-pwa-prompt?

A React component to prompt the user to add the app as a PWA to the home screen with native iOS styles. Visit Snyk Advisor to see a full health score report for react-ios-pwa-prompt, including popularity, security, maintenance & community analysis.

Is react-ios-pwa-prompt popular?

The npm package react-ios-pwa-prompt receives a total of 2,762 weekly downloads. As such, react-ios-pwa-prompt popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-ios-pwa-prompt well maintained?

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

Is react-ios-pwa-prompt safe to use?

While scanning the latest version of react-ios-pwa-prompt, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 8 November-2024, at 18:47 (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