/react-speech-recognition-status

A react component for speech recognition

Primary LanguageJavaScriptMIT LicenseMIT

Build Status Coverage Status Codacy Badge

React Speech Recognition Status

React component useful to display the speech recognition status

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

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