[Website](https://www.speechly.com/)
·
[Docs](https://docs.speechly.com/)
·
[Support](https://github.com/speechly/speechly/discussions)
·
[Blog](https://www.speechly.com/blog/)
·
[Login](https://api.speechly.com/dashboard/)
# Speechly Browser UI Components
[](https://www.npmjs.com/package/@speechly/browser-ui)
[](/LICENSE)
Ready-made UI components for building reactive voice interface using JavaScript and Speechly.
> 🚧 This project is no longer actively maintained and is looking for a maintainer. If you're interested, get in touch https://www.speechly.com/contact
## Documentation
- [Getting started with Speechly](https://docs.speechly.com/basics/getting-started)
- [Speechly UI components](https://dreamy-cori-a02de1.netlify.app/ui-components/)
- [API reference](./docs/index.md)
## Getting started
You'll need a [Speechly account](https://api.speechly.com/dashboard/) and a Speechly application that's using a Conformer model. Follow our [quick start guide](https://docs.speechly.com/basics/getting-started) to get started with Speechly.
## Browser usage
Include the Web Components from a CDN that mirrors [`@speechly/browser-ui`](https://www.npmjs.com/package/@speechly/browser-ui) npm package. The script tags register `push-to-talk-button`, `big-transcript` and `intro-popup` with the browser's customElement registry so you can use them like regular tags.
```html
You'll be able to control this web app faster with voice.
```
## Node Usage
> This example illustrates using browser-ui Web Components with a JS framework. For React development, [react-client](../react-client) and [react-ui](../react-ui) libraries offer a better developer experience.
```bash
npm install @speechly/browser-ui
```
In App.js:
```js
import "@speechly/browser-ui/core/push-to-talk-button";
import "@speechly/browser-ui/core/big-transcript";
import "@speechly/browser-ui/core/intro-popup";
// ...
```
## Contributing
See contribution guide in [CONTRIBUTING.md](https://github.com/speechly/speechly/blob/main/CONTRIBUTING.md).