# react-voice-decorator

> react voice recorder component using navigator's mediaDevices and MediaRecorder api that provides record/play/pause functionalities for developers using render-props design pattern

Latest version **1.5.3** (published 2020-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-voice-decorator
pnpm add react-voice-decorator
yarn add react-voice-decorator
bun add react-voice-decorator
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.3 |
| Published | 2020-11-06 |
| First published | 2020-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Amirmohammad Moradi |
| Maintainers | ammoradi |
| Keywords | react, recorder, voice, sound, voice-recorder, navigator, mediaDevices, MediaRecorder |

## Links

- npm: https://www.npmjs.com/package/react-voice-decorator
- Repository: https://github.com/ammoradi/react-voice-decorator
- Homepage: https://github.com/ammoradi/react-voice-decorator#readme
- Issues: https://github.com/ammoradi/react-voice-decorator/issues
- npm.io page: https://npm.io/package/react-voice-decorator

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [@use-it/interval](https://npm.io/package/@use-it/interval.md) ^0.1.3

## 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

- 1.5.3 (latest) — 2020-11-06
- 1.5.2 — 2020-11-06
- 1.5.0 — 2020-11-06
- 1.3.1 — 2020-11-05
- 1.3.0 — 2020-11-05
- 1.2.0 — 2020-11-02
- 1.1.0 — 2020-11-02
- 1.0.3 — 2020-11-01
- 1.0.2 — 2020-11-01
- 1.0.1 — 2020-11-01
- 1.0.0 — 2020-11-01

## README

# react-voice-decorator
React voice recorder component using `navigator`'s `mediaDevices` and `MediaRecorder `api that provides record/play/pause functionalities for developers using **render-props** design pattern.

## demo
see **[Demo](https://codesandbox.io/s/react-voice-recorder-demo-9i8ik)** at **[https://codesandbox.io/s/react-voice-recorder-demo-9i8ik](https://codesandbox.io/s/react-voice-recorder-demo-9i8ik)**

## usage
* add package using `yarn`

```
    yarn add react-voice-decorator
```

* use the render-props component:

```js
import React, { useCallback, useRef } from 'react'

import VoiceDecorator from 'react-voice-decorator'

export default function App() {
  const voiceRef = useRef(null)

    const getVoice = useCallback((getterFn) => {
    voiceRef.current = getterFn()
  }, [])

  return (
    <div>
      <VoiceDecorator
        render={(props) => (
          <>
            <h1 onClick={props.toggleRecord}>
              {props.isRecording ? 'Stop Recording' : 'Record'}
            </h1>
            <h1 onClick={props.togglePlay}>
              {props.isPlaying ? 'Pause' : 'Play'}
            </h1>
          </>
        )}
        voiceGetter={getVoice}
      />
    </div>
  )
}
```

* available props:

| prop key | type |
|  :---:  | :-: |
| toggleRecord | function |
| togglePlay | function |
| isPlaying | boolean |
| isRecording | boolean |
| voiceGetter | function |

## ref
You can get recorded voice as an audio object using react ref

## limitation
_This package doesn't work on Safari with iOS versions lower than 13.4 (for the higher versions it works fine)_

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