Skip to content

Commit

Permalink
add speech to text feature
Browse files Browse the repository at this point in the history
  • Loading branch information
ranbuch committed Oct 3, 2016
1 parent e581bd5 commit 807996f
Show file tree
Hide file tree
Showing 5 changed files with 179 additions and 29 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@

### beta version!
* first copy and past /dist/accessibility.min.js to your site (via dev tools)
* then enter `new window.Accessibility();`
* then enter `new Accessibility();`
* works for your site? use it! not working? open an issue or request a feature
* [open an issue if necessary](https://github.com/ranbuch/accessibility/issues)

### DESCRIPTION:
**Features:**
Expand All @@ -16,6 +17,7 @@
- [x] gray hues
- [x] underline links
- [x] text to speech
- [x] speech to text

>Does not depend any other directory (**jQuery is not required**).
Easy to use!
Expand All @@ -28,7 +30,7 @@ include script:
`<script type="text/javascript" src="node_modules/accessibility/dist/accessibility.min.js"></script>`
initialize component:
`window.addEventListener('load', function() {
new window.Accessibility();
new Accessibility();
}, false);`

### LIMITATIONS:
Expand All @@ -44,13 +46,13 @@ initialize component:
invertColors: 'invert colors (in my language)',
grayHues: 'gray hues (in my language)',
underlineLinks: 'underline links (in my language)',
textToSpeech: 'text to speech (in my language)'`

textToSpeech: 'text to speech (in my language)',
speechToText: 'speech to text (in my language)'`
`};`

`var options = { labels: labels };`
`options.textToSpeechLang = 'en-US'; // or any other language`
`new window.Accessibility(options);`
`new Accessibility(options);`

### disable features example:
`options.modules = {`
Expand All @@ -59,16 +61,16 @@ initialize component:
`invertColors: [true/false],`
`grayHues: [true/false],`
`underlineLinks: [true/false],`
`textToSpeech: [true/false]`

`textToSpeech: [true/false],`
`speechToText: [true/false]`
`};`

>When the default is **true**
### text size manipulation approaches
If text increase / decrease isn't working for your size your probablly not using responsive font size units (sutch as em, rem etc.).
In that case you can initialize the accessibility tool like this:
`new window.Accessibility({textPixelMode: true})`
`new Accessibility({textPixelMode: true})`

### LICENSE
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://spdx.org/licenses/MIT)
Loading

0 comments on commit 807996f

Please sign in to comment.