![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# stencil-voice2text

wc-voice2text is a web component built with [Stencil](https://stenciljs.com/) that allows you to use the [Web Speech API](https://developers.google.com/web/updates/2013/01/Voice-Driven-Web-Apps-Introduction-to-the-Web-Speech-API).

## Getting Started

To try this component:

```bash
git clone git@github.com:Fdom92/stencil-voice2text.git
cd my-app
git remote rm origin
```

and run:

```bash
npm install
npm start
```

## Using this component

### Script tag

- Put `<script src='https://unpkg.com/stencil-voice2text@latest/dist/voice2text.js'></script>` in the head of your index.html
- Then you can use the element like this:
```html
<wc-voice2text>
    <input type="text"></input>
</wc-voice2text>
```

### Node Modules
- Run `npm install stencil-voice2text --save`
- Put a script tag similar to this `<script src='node_modules/stencil-voice2text/dist/voice2text.js></script>` in the head of your index.html
- Then you can use the element like this:
```html
<wc-voice2text>
    <input type="text"></input>
</wc-voice2text>
```

### In a stencil-starter app
- Run `npm install stencil-voice2text --save`
- Add `{ name: 'stencil-voice2text' }` to your [collections](https://github.com/ionic-team/stencil-starter/blob/master/stencil.config.js#L5)
- Then you can use the element like this:
```html
<wc-voice2text>
    <input type="text"></input>
</wc-voice2text>
```

> You can use it with ion input too, just import the ionic core collection:
>```html
><wc-voice2text>
>    <ion-input></ion-input>
></wc-voice2text>
>```

## Parameters

Attribute | Default | Description
------------ | ------------- | -------------
enabled | true | Make the speech recognition available or not
continuous | false | Make the speech recognition ends when the user stops talking or continue.
lang | `en-US` | Make the speech recognition use english.