use-pwa/README.md

React hook for PWA installation detection and handling

# use-pwa

React hook for detecting and handling PWA (Progressive Web App) installation.

[Demo](https://use-pwa.kkweb.io/)

## Installation

```bash
npm install use-pwa
```

## Usage

```tsx
import usePwa from "use-pwa";

function App() {
  const { canInstall, install, isInstalled, isSupported } = usePwa();

  if (!isSupported || isInstalled) {
    return null;
  }

  return (
    <button disabled={!canInstall} onClick={install}>
      Install PWA
    </button>
  );
}
```

## API

### `usePwa(): PwaData`

| Property | Type | Description |
|----------|------|-------------|
| `canInstall` | `boolean` | `true` when install prompt is available |
| `install` | `() => Promise<UserChoice \| undefined>` | Triggers the install prompt |
| `isInstalled` | `boolean` | `true` when running as installed PWA |
| `isSupported` | `boolean` | `true` when browser supports PWA installation |

### `UserChoice`

Returned by `install()` when the user responds to the prompt:

| Property | Type | Description |
|----------|------|-------------|
| `outcome` | `"accepted" \| "dismissed"` | User's choice |
| `platform` | `string` | Platform string |

## Features

- Simple 4-property API
- Detects PWA install prompts
- Browser support detection
- Standalone mode detection
- SSR compatible
- TypeScript support

## License

MIT