1.0.1 • Published 2 years ago

use-pwa-install v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

use-pwa-install

React hook for PWA(Progressive Web App) install

Demo

Demo

Install

npm i use-pwa-install

Usage

import React from 'react';
import usePWAInstall from 'use-pwa-install';

const App = () => {
  const { isInstalled, install } = usePWAInstall();

  return (
    <div>
      {isInstalled ? (
        <p>App is installed</p>
      ) : (
        <button onClick={install}>Install</button>
      )}
    </div>
  );
};

Options

optionsTypeDescriptionRequiredDefault Value
acceptedFnFunctionCallback function to execute when acceptednoconsole.log()
dismissedFnFunctionCallback function to execute when dismissednoconsole.log()
installedFnFunctionCallback function to execute when installednoconsole.log()

Return value

valueTypeDescription
isInstalledbooleanInstall state
installFunctionApp install function

Browser compatibility