React Hook

Use the usePWAInstall hook to combine environment detection, deferred prompt lifecycle, and guide lookup in React.

The usePWAInstall hook combines environment detection, deferred prompt lifecycle, and guide lookup into a single React hook.

usePWAInstall(options?)

const {
  environment,
  canPrompt,
  promptInstall,
  status,
  guide,
} = usePWAInstall();

What the hook does

Captures beforeinstallprompt events.
Exposes canPrompt to check if native install is available.
Runs promptInstall() only when a deferred prompt exists.
Reacts to appinstalled events.
Keeps manual guides and native prompts mutually exclusive.

Runtime API

Use detectInstallEnvironment and getInstallGuide to detect browser capabilities and generate manual install content.

Manifest Module

Use generateManifest and mergeManifest to create and update web app manifests programmatically.

On this page

usePWAInstall(options?)What the hook does