{"id":23505872,"url":"https://github.com/grvcoelho/react-voice-components","last_synced_at":"2025-04-09T15:08:04.478Z","repository":{"id":57347482,"uuid":"75975422","full_name":"grvcoelho/react-voice-components","owner":"grvcoelho","description":"Set of React components that use the Web Speech API to bring voice experience to React applications","archived":false,"fork":false,"pushed_at":"2018-03-20T06:09:12.000Z","size":341,"stargazers_count":196,"open_issues_count":7,"forks_count":36,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-09T15:07:48.452Z","etag":null,"topics":["javascript","react","react-component","web-speech-api"],"latest_commit_sha":null,"homepage":"https://grvcoelho.github.io/react-voice-components/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grvcoelho.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-08T21:10:47.000Z","updated_at":"2024-07-14T08:59:19.000Z","dependencies_parsed_at":"2022-08-28T03:01:27.248Z","dependency_job_id":null,"html_url":"https://github.com/grvcoelho/react-voice-components","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grvcoelho%2Freact-voice-components","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grvcoelho%2Freact-voice-components/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grvcoelho%2Freact-voice-components/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grvcoelho%2Freact-voice-components/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grvcoelho","download_url":"https://codeload.github.com/grvcoelho/react-voice-components/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248055284,"owners_count":21040157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","react","react-component","web-speech-api"],"created_at":"2024-12-25T09:46:17.119Z","updated_at":"2025-04-09T15:08:04.460Z","avatar_url":"https://github.com/grvcoelho.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-voice-components\n\n[![Build Status](https://travis-ci.org/grvcoelho/react-voice-components.svg?branch=master)](https://travis-ci.org/grvcoelho/react-voice-components)\n\nSet of React components that use the Web Speech API to bring voice experience to React applications. Check out the :sparkles: :gem: [**LIVE DEMO**](https://grvcoelho.github.io/react-voice-components/?) :gem: :sparkles:\n\n## Install\n\nInstall the components using npm:\n\n```sh\n$ npm install --save react-voice-components\n```\n\n## Usage\n\n1. Import components:\n\n  ```javascript\n  import { VoicePlayer, VoiceRecognition } from 'react-voice-components'\n  ```\n\n2. Use it:\n\n  ```jsx\n  ReactDOM.render(\n    \u003cVoicePlayer\n      play\n      text=\"React voice player demonstration\"\n    /\u003e,\n    document.getElementById('root')\n  )\n  ```\n\n## API\n\n### `\u003cVoicePlayer /\u003e`\n\nProvides you a simple React component to do speech synthesis (text to speech).\n\n#### Options\n\n| Property | Options   | Description                                           |\n|----------|-----------|-------------------------------------------------------|\n| play     | *boolean* | Specifies if the speech should be played when mounted. |\n| pause    | *boolean* | Specifies if the speech should pause                  |\n| text     | *string*  | Specifies the text that shall be spoken.              |\n| lang     | `en-US`, `en-GB`, `es-ES`, `fr-FR`, `it-IT`, `de-DE`, `ja-JP`, `pt-BR`, `zh-CN` | Specifies the accent and language the speech will be spoken.\n\n#### Event Callbacks\n\n| Property | Description                                  |\n|----------|----------------------------------------------|\n| onStart  | Runs when the speech starts to be spoken.    |\n| onEnd    | Runs when the speech completes to be spoken. |\n| onPause  | Runs when te speech is paused.               |\n| onResume | Runs when the speech is resumed.             |\n\n\n### `\u003cVoiceRecognition /\u003e`\n\nProvides you a simple React component to do voice recognition (speech to text).\n\n#### Options\n\n| Property   | Options   | Description                                                                       |\n|------------|-----------|-----------------------------------------------------------------------------------|\n| continuous | *boolean* | Specifies if the recognition should continue when the user pauses while speaking. |\n| stop       | *boolean* | Specifies if the recognition should be stoped (when used with `continuous=true`)  |\n\n#### Event Callbacks\n\n| Property | Description                              |\n|----------|------------------------------------------|\n| onStart  | Runs when the recognition starts.        |\n| onEnd    | Runs when the recognition ends.          |\n| onError  | Runs when there is a recognition error.  |\n| onResult | Runs when there is a recognition result. |\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -m 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## LICENSE\n[MIT](https://github.com/grvcoelho/react-voice-components/blob/master/LICENSE) (c) 2017 Guilherme Rv Coelho\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrvcoelho%2Freact-voice-components","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrvcoelho%2Freact-voice-components","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrvcoelho%2Freact-voice-components/lists"}