react-text-to-speech

react-text-to-speech

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

Features

• Text-to-speech functionality
• Easy to use
• Highlights words as they are read (see highlighting text using useSpeech Hook and Speech Component).
• Provides API to handle errors and events (see Handling Errors and Events).
• Handles multiple speech instances easily (see handling using useSpeech Hook and Speech Component).
• Fully Customizable (see useSpeech Hook Usage and usage with FaC).
• Overcomes the Web Speech API's text limit, allowing for infinite text input.
• Automatically stops speech instances on component unmount.

Installation

To install react-text-to-speech:

  # with npm:
  npm install react-text-to-speech --save

  # with yarn:
  yarn add react-text-to-speech

  # with pnpm:
  pnpm add react-text-to-speech

  # with 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 through the useSpeech hook and the <Speech> component.

useSpeech hook

Basic Usage

import React from "react";
import { useSpeech } from "react-text-to-speech";

export default function App() {
  const {
    Text, // Component that returns the modified text property
    speechStatus, // String that stores current speech status
    isInQueue, // Boolean that stores whether a speech utterance is either being spoken or present in queue
    start, // Function to start the speech or put it in queue
    pause, // Function to pause the speech
    stop, // Function to stop the speech or remove it from queue
  } = useSpeech({ text: "This library is awesome!" });

  return (
    <div style={{ display: "flex", flexDirection: "column", rowGap: "1rem" }}>
      <Text />
      <div style={{ display: "flex", columnGap: "0.5rem" }}>
        {speechStatus !== "started" ? <button onClick={start}>Start</button> : <button onClick={pause}>Pause</button>}
        <button onClick={stop}>Stop</button>
      </div>
    </div>
  );
}

Detailed Usage

For detailed usage of useSpeech hook, refer here

Speech Component

Basic Usage

import React from "react";
import Speech from "react-text-to-speech";

export default function App() {
  return <Speech text="This library is awesome!" />;
}

Detailed Usage

For detailed usage of <Speech> component, refer here

Demo

A Demo is worth a thousand words

Documentation

Check the documentation to get you started!

Contribute

Show your ❤️ and support by giving a ⭐. Any suggestions are welcome! Take a look at the contributing guide.

Changelog

0.19.0 (15-09-2024)

• feat: autoPlay prop in useSpeech hook and <Speech> component.
• fix: Multiple issues in Firefox, including incorrect text highlighting and the stop function not working correctly.
• fix: Typo in documentation.
• refactor: Improved internal code for better maintainability.