use-before-install-prompt

use-before-install-prompt

React hook for beforeinstallprompt event

Install

npm i use-before-install-prompt

Usage

import React from 'react';
import useBeforeInstallPrompt from 'use-before-install-prompt';

const App = () => {
  const { addToHomeScreen } = useBeforeInstallPrompt();

  return <button onClick={addToHomeScreen}>Add to home screen</button>;
};

Options

options	Type	Description	Required	Default Value
acceptedFn	Function	Callback function to execute when accepted	no	console.log()
dismissedFn	Function	Callback function to execute when dismissed	no	console.log()
afterInstallPromptFn	Function	Callback function to execute after installed	no	console.log()

Return value

value	Type	Description
deferredPrompt	MutableRefObject<BeforeInstallPromptEvent|undefined>	deferredPrompt Ref
addToHomeScreen	Function	Add to home screen function

Browser compatibility

https://developer.mozilla.org/en-US/docs/Web/API/BeforeInstallPromptEvent#browser_compatibility