# voice-interaction

> simple module to interact with your site using voice

Latest version **1.0.8** (published 2018-01-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install voice-interaction
pnpm add voice-interaction
yarn add voice-interaction
bun add voice-interaction
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2018-01-30 |
| First published | 2017-10-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | mmmaxou |
| Maintainers | mmmaxou |

## Links

- npm: https://www.npmjs.com/package/voice-interaction
- Repository: https://github.com/mmmaxou/voice-interaction
- Homepage: https://github.com/mmmaxou/voice-interaction#readme
- Issues: https://github.com/mmmaxou/voice-interaction/issues
- npm.io page: https://npm.io/package/voice-interaction

## Recent versions

- 1.0.8 (latest) — 2018-01-30
- 1.0.7 — 2017-12-03
- 1.0.6 — 2017-12-03
- 1.0.5 — 2017-10-29
- 1.0.3 — 2017-10-27
- 1.0.2 — 2017-10-27
- 1.0.1 — 2017-10-27
- 1.0.0 — 2017-10-27

## README

# Voice-Interaction

Interact with your website using your voice

Status: <b>Development</b>

### Installation

```
npm install --save voice-interaction
```

### Example

Link the library to your app
```
<script src="voice-interaction.js"></script>
```

Add Annyang and SpeechKITT
( This library is using annyang in order to detect and recognize patterns in your speach )
```
<script src="https://cdnjs.cloudflare.com/ajax/libs/annyang/2.6.0/annyang.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/SpeechKITT/0.3.0/speechkitt.min.js"></script>
```
https://www.talater.com/annyang/

Add the tags \[data-voice=`"<what-to-say>"`\] to your links `<a>`
```
<ul>
	<li>
    <a href="page-1" data-voice="page one">Page 1</a>
    <a href="page-2" data-voice="page two">Page 2</a>
    <a href="page-3" data-voice="page three">Page 3</a>
  </li>
</ul>
```

Then start the library

```
import VoiceInteraction from './docs/voice-interaction.js'

document.addEventListener("DOMContentLoaded", function (event) {
  var Voice = new VoiceInteraction()
})
```
You can also specify a CSS selector to only use VoiceInteraction on a part of the DOM
```
var Voice = new VoiceInteraction( "#my-content" )
```

---
_Source: https://npm.io/package/voice-interaction · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._