# react-use-navigator-permissions

> [![Build Status](https://github.com/JamesIves/react-use-navigator-permissions/workflows/unit-tests/badge.svg)](https://github.com/JamesIves/react-use-navigator-permissions/actions) [![Codecov Coverage](https://codecov.io/gh/JamesIves/react-use-navigator-p

Latest version **0.1.2** (published 2020-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-use-navigator-permissions
pnpm add react-use-navigator-permissions
yarn add react-use-navigator-permissions
bun add react-use-navigator-permissions
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-02-24 |
| First published | 2020-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | James Ives |
| Maintainers | jamesives |
| Keywords | react, react-hook, react-hooks, navigator-api, browser, browser-api |

## Links

- npm: https://www.npmjs.com/package/react-use-navigator-permissions
- npm.io page: https://npm.io/package/react-use-navigator-permissions

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2020-02-24
- 0.1.1 — 2020-02-24

## README

# useNavigatorPermissions Hook 🔗 🗺️
[![Build Status](https://github.com/JamesIves/react-use-navigator-permissions/workflows/unit-tests/badge.svg)](https://github.com/JamesIves/react-use-navigator-permissions/actions) [![Codecov Coverage](https://codecov.io/gh/JamesIves/react-use-navigator-permissions/branch/master/graph/badge.svg)](https://codecov.io/gh/JamesIves/react-use-navigator-permissions/branch/master)

This [React Hook](https://reactjs.org/docs/hooks-overview.html) allows you to make a query to see if a user has either accepted or denied permissions to a given [navigator api](https://developer.mozilla.org/en-US/docs/Web/API/Navigator).

## Getting Started ✈️
You can install this hook using Yarn.

```
yarn add react-use-navigator-permissions
```

It can then be included in your project like so.

```javascript
import useNavigatorPermissions from 'react-use-navigator-permissions'

const Component = () => {
  const { status, error } = useNavigatorPermissions('geolocation')

  return (
    <div>{status}</div>
  )
}
```

The first argument accepts the api name, and the second accepts a series of [configuration parameters](https://developer.mozilla.org/en-US/docs/Web/API/Permissions/query).

## Browser Compatibility 📣

This hook utilizes `window.navigator.permissions` which is not widely supported by all browsers. For information on what browser supports what [please refer to the documentation](https://developer.mozilla.org/en-US/docs/Web/API/Permissions/query).

---
_Source: https://npm.io/package/react-use-navigator-permissions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._