@speechly/browser-ui
Advanced tools
Ready made Speechly UI components to build a reactive voice interface to a web site or app. See these CodePens for a preview:
If you want to build a custom interface for you web app, you may want to check out browser-client (npm) for direct access to Speechly API.
Include the Web Components from a CDN that mirrors @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.
<head>
<script type="text/javascript" src="https://unpkg.com/@speechly/browser-ui/core/push-to-talk-button.js"></script>
<script type="text/javascript" src="https://unpkg.com/@speechly/browser-ui/core/big-transcript.js"></script>
<script type="text/javascript" src="https://unpkg.com/@speechly/browser-ui/core/intro-popup.js"></script>
</head>
<body>
<big-transcript
placement="top">
</big-transcript>
<push-to-talk-button
placement="bottom"
appid="YOUR_APP_ID_FROM_SPEECHLY_DASHBOARD">
</push-to-talk-button>
<intro-popup>
<span slot="priming-body">You'll be able to control this web app faster with voice.</span>
</intro-popup>
</body>
This example illustrates using browser-ui Web Components with a JS framework. For React development, react-client and react-ui libraries offer a better developer experience.
npm i @speechly/browser-ui
In App.js:
import "@speechly/browser-ui/core/push-to-talk-button";
import "@speechly/browser-ui/core/big-transcript";
import "@speechly/browser-ui/core/intro-popup";
...
<big-transcript placement="top"></big-transcript>
<push-to-talk-button placement="bottom" appid="YOUR_APP_ID_FROM_SPEECHLY_DASHBOARD"></push-to-talk-button>
<intro-popup></intro-popup>
The build steps are needed if you want to contibute to the development of the components or need to fork them for customization.
npm install -g @microsoft/rush
rush update
# Build dependencies
rush build --to-except browser-ui
# Compile the library, serve the testbench pages and watch changes
rushx dev
Open http://localhost:5000 or http://localhost:5000/extras to see the components on testbench pages.
rush update
rush build --to browser-ui
# Check build artefacts
ls core/
FAQs
Ready-made UI components to build a reactive voice interface to a web site or app. Uses Speechly's real-time cloud API for speech-to-text and NLU.
The npm package @speechly/browser-ui receives a total of 351 weekly downloads. As such, @speechly/browser-ui popularity was classified as not popular.
We found that @speechly/browser-ui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.