@huluvu424242/honey-speech
Version:
Text to Speech component wich is reading texts from DOM elements.
164 lines (106 loc) • 4.19 kB
Markdown
[](https://www.webcomponents.org/element/@huluvu424242/honey-speech)
# honey-speech
(**2020-11-30 @huluvu/honey-speech -> moved to [@huluvu/honey-speaker](https://github.com/PIUGroup/honey-speaker)**)
This component realize an speaker symbol button. Its can read a text of
DOM elements referenced by an list of ids via voice.
## installation
npm install --save honey-speech
## usage
```html
<script
type="module"
src='https://unpkg.com/@huluvu424242/honey-speech@0.0.13/dist/honey-speech/honey-speech.js'>
</script>
```
To the [demo site](https://huluvu424242.github.io/honey-speech/index.html)
[Vision of API (under construction)](src/components/honey-speech/readme.md)
## demo
<!--
```
<custom-element-demo>
<template>
<link rel="import" href="docs/index.html">
<next-code-block></next-code-block>
</template>
</custom-element-demo>
```
-->
```html
<honey-speech textids="text1,text2"></honey-speech>
<p id="text1">fizz fizz fizz fizz</p>
<p id="text2">buzz buzz buzz buzz</p>
```
To the [live demo](https://huluvu424242.github.io/honey-speech/index.html)
## become an supporter
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## releaselog
### v0.0.14 unpublished
* n/a
### v0.0.13 2020-11-06
* initializing of voices fixed
* [issue2](https://github.com/Huluvu424242/honey-speech/issues/2) e2e tests fixed
* css support of ::part removed (to complex for end user)
* a11y: tabindex=0, keydown: space and enter, role="button", alt text, svg role="img"
* speaker realized as toggle button
* custom css attribute names changed
### v0.0.12 published at 2020-02-29
* docu and demo urls fixed
### v0.0.11 published at 2020-02-29
* support of voice parameter
### v0.0.10 published at 2020-02-28
* support for large texts added
* defined css variables supported
* css ::part supported for speakerpane
* svg embed - no extra assets needed
* sizeable via css
* color of background, stroke and fill css styleable
* ident property computed from id attribute or random if absent
* example added
* stencil/core removed from bundle again (no storybook support at now)
### v0.0.9 published at 2020-02-23
* stencil/core added to bundle
### v0.0.8
* readme updated
* icon color blue
* background color attribute added
### v0.0.7
* first working version with icon.
* support of id list of speaker texts.
### v0.0.2 - v0.0.6
* try to publish assets with component to npmjs.com but failed.
### v0.0.1
* setup project based at https://github.com/ionic-team/stencil-component-starter rating-stencil-component
## internet links
* https://auth0.com/blog/creating-web-components-with-stencil/
* https://www.twilio.com/blog/2018/02/creating-and-publishing-web-components-with-stencil.html
* https://stenciljs.com/docs/introduction
* https://css-tricks.com/styling-a-web-component/
* https://meowni.ca/posts/part-theme-explainer/
## warranty
no warranty
## license
MIT License
## technology used
* [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API)
* [Custom Elements](https://developer.mozilla.org/en-US/docs/Web/API/Window/customElements)
* [CSS Custom Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties)
* [Shadow Parts](https://developer.mozilla.org/de/docs/Web/CSS/::part)
## browser support
### Web Speech API
Firefox
Maybe you must via about:config set media.webspeech.synth.enabled to true
Generell
* [Can I use with browsers?](https://caniuse.com/#feat=speech-synthesis)
### Custom Elements
* [Can I use with browsers?](https://caniuse.com/#feat=mdn-api_window_customelements)
### CSS Custom Properties
* [Can I use with browsers?](https://caniuse.com/#search=css%20custom%20properties)
### Shadow Parts
Firefox
Maybe you must via about:config set the layout.css.shadow-parts.enabled to true.
Generell
* [Can I use with browsers?](https://caniuse.com/#feat=mdn-css_selectors_part)