An easy-to-use React.js component for the Web Speech API.
It is as easy as to import a React.js component!
- Text-to-speech
- 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
- Stops speech instance on component unmount.
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-speechreact-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.
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>
);
}For detailed usage of useSpeech hook, refer here
import React from "react";
import Speech from "react-text-to-speech";
export default function App() {
return <Speech text="This library is awesome!" />;
}For detailed usage of <Speech> component, refer here
A Demo is worth a thousand words
Check the documentation to get you started!
Show your ❤️ and support by giving a ⭐. Any suggestions are welcome! Take a look at the contributing guide.