# react-speech-recognition-status

> React component useful to display the speech recognition status

Latest version **1.2.8** (published 2018-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-speech-recognition-status
pnpm add react-speech-recognition-status
yarn add react-speech-recognition-status
bun add react-speech-recognition-status
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.8 |
| Published | 2018-09-30 |
| First published | 2017-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 37.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Javier Perez |
| Maintainers | sljavi |

## Links

- npm: https://www.npmjs.com/package/react-speech-recognition-status
- Repository: https://github.com/sljavi/react-speech-recognition-status
- Issues: https://github.com/sljavi/react-speech-recognition-status/issues
- npm.io page: https://npm.io/package/react-speech-recognition-status

## Dependencies (1)

- [classnames](https://npm.io/package/classnames.md) ^2.2.5

## Recent versions

- 1.2.8 (latest) — 2018-09-30
- 1.2.7 — 2018-09-30
- 1.1.7 — 2018-08-12
- 1.1.6 — 2018-03-13
- 1.1.5 — 2018-03-06
- 1.0.5 — 2018-03-04
- 1.0.4 — 2018-03-04
- 1.0.3 — 2018-03-04
- 1.0.2 — 2017-07-05
- 1.0.1 — 2017-07-05
- 1.0.0 — 2017-07-04

## README

[![Build Status](https://travis-ci.org/sljavi/react-speech-recognition-status.svg?branch=master)](https://travis-ci.org/sljavi/react-speech-recognition-status) [![Coverage Status](https://coveralls.io/repos/github/sljavi/react-speech-recognition-status/badge.svg?branch=master)](https://coveralls.io/github/sljavi/react-speech-recognition-status?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/6759438331b94413b9a741fbd2c9a01d)](https://www.codacy.com/app/javi-pzv/react-speech-recognition-status?utm_source=github.com&utm_medium=referral&utm_content=sljavi/react-speech-recognition-status&utm_campaign=Badge_Grade)

# React Speech Recognition Status

React component useful to display the speech recognition status

![](http://i.imgur.com/OIOiPw4.png)

## Install

```
npm install react-speech-recognition-status
```

## Requirements

### NPM modules
- `>=react@15`
- `>=react-dom@15`
- `>=prop-types@15`

### Styles
- `font-awesome` has to be loaded

## Usage

```javascript
import SpeechRecognitionStatus from 'react-speech-recognition-status';

const SpeechRecognitionStatusComponent = <SpeechRecognitionStatus
  contextName='Foo'
  recording
  final
  text='hello world'
/>
```

## Supported Options

- `contextName(string)`: Displays a label at the left of the transcription
- `error(bool)`: When is `true` displays an error icon
- `connecting(bool)`: When is `true` displays a connecting icon
- `recording(bool)`: When is `true` displays a mic icon
- `final(bool)`: When is `true` adds a classname `'final'` to the text container
- `text(string)`: Displays the given transcription into the text container
- `compact(bool)`: When is `true` displays compacted version
- `volume(number)`: When `recording` is `true` the mic icon shows the volume level

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