Introduction

react-text-to-speech is an easy-to-use React.js component that leverages the Web Speech API to convert text to speech.

Features

• Converts text to speech using the Web Speech API.
• Highlights words as they are read aloud. See:
  • Highlighting text with the useSpeech hook.
  • Highlighting text with the Speech component.
• Provides an API for handling errors and events:
  • Handling errors and events with the useSpeech hook.
  • Handling errors and events with the Speech component.
• Manages multiple speech instances:
  • Multiple instances with the useSpeech hook.
  • Multiple instances with the Speech component.
• Fully customizable for various use cases:
  • Using the useSpeech hook.
  • Customizing the Speech component.
• Overcomes the Web Speech API's text length limit, enabling infinite text input.
• Automatically stops speech instances when the component unmounts.

Installation

Install react-text-to-speech using:

npm

npm install react-text-to-speech --save

yarn

yarn add react-text-to-speech

pnpm

pnpm add react-text-to-speech

bun

bun add react-text-to-speech

Usage

react-text-to-speech offers two main ways to integrate text-to-speech functionality into your React.js applications.

• useSpeech hook
• <Speech> component