Package Exports

react-say

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-say) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-say

A React component that synthesis text into speech using Web Speech API.

This project scaffold can be found at compulim/react-component-template.

Demo

Try out the demo at https://compulim.github.io/react-say/.

How to use

First, run npm install react-say for production build. Or run npm install react-say@master for latest development build.

Simple scenario

The following will speak the text immediately upon showing up. Some browsers may not speak the text until the user interacted with the page.

import BasicSay from 'react-say';

export default props =>
  <BasicSay
    text="A quick brown fox jumped over the lazy dogs."
  />

Customizing pitch/rate

You may want to customize the speech by varying pitch and rate. You can use <Composer> and <Say> to say your text.

import { Composer, Say } from 'react-say';

export default props =>
  <Composer
    pitch={ 1.1 }
    rate={ 1.5 }
  >
    <Say
      text="A quick brown fox jumped over the lazy dogs."
    />
  </Composer>

Note: variation will take effect for new/modified <Say>

Say button

Since some browsers may block speak synthesis before the user interacting with the page, you can use <SayButton> for the purpose.

import { Composer, SayButton } from 'react-say';

export default props =>
  <Composer>
    <SayButton
      onClick={ event => console.log(event) }
      text="A quick brown fox jumped over the lazy dogs."
    >
      Tell me a story
    </SayButton>
  </Composer>

Contributions

Like us? Star us.

Want to make it better? File us an issue.

Don't like something you see? Submit a pull request.