1.0.1 • Published 1 year ago

react-tts-voice v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

react-tts-voice

A React library for text-to-speech functionality.

Installation

npm install react-tts

Usage

import React from "react";
import speech from "react-tts";

const App = () => {
  const text = "Hello, this is a sample text to be spoken.";

  return (
    <div>
        <button
            onClick={() =>
                speech({
                    text,
                    lang: 'en-GB',
                    volume: 0.8,
                    rate: 1.2,
                    pitch: 1.1,
                    voice: 'Google UK English Male'
                })
            }
        >
            Speak Text
        </button>
    </div>
  );
};

export default App;

API

The speech function accepts an object with the following properties:

PropertyTypeDescriptionRequired
textstringThe text to be spokenYes
langstringThe language of the speech. Default is 'en-US'.No
volumenumberThe volume of the speech. Range is from 0 to 1. Default is 1.No
ratenumberThe rate of the speech. Range is from 0.1 to 10. Default is 1.No
pitchnumberThe pitch of the speech. Range is from 0 to 2. Default is 1.No
voicestringThe name of the voice to be used. Default is null.No

Available Voices

You can use the speechSynthesis.getVoices() method to get a list of available voices. Here are some common voices:

console.log(window.speechSynthesis.getVoices());
Voice NameLanguage
Google US Englishen-US
Google UK English Maleen-GB
Google UK English Femaleen-GB
Google españoles-ES
Google françaisfr-FR
Google Deutschde-DE
Google italianoit-IT
Google 日本語ja-JP
Google 한국의ko-KR
Google 中文(普通话)zh-CN

Contributions

We welcome contributions to improve this library. We appreciate your contributions and will review and merge them as quickly as possible. If you have any questions or need assistance, feel free to open an issue. To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and commit them with clear and concise messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request with a detailed description of your changes.
1.0.1

1 year ago

1.0.0

1 year ago