Skip to content

Commit

Permalink
Add prop documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DannyFeliz committed Nov 5, 2019
1 parent afcf54f commit d9499ec
Showing 1 changed file with 52 additions and 1 deletion.
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,83 @@
# vue-email-dropdown

# Demo
![Demo](https://github.com/DannyFeliz/vue-email-dropdown/blob/master/demo/demo.gif)

![Demo](https://github.com/DannyFeliz/vue-email-dropdown/blob/master/demo/demo.gif)

# Props

<table>
<thead>
<tr>
<th>Prop</th>
<th>Type</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>domains</td>
<td>Array</td>
<td>True</td>
<td>-</td>
<td>All domains that should be used to make a domain suggestions.</td>
</tr>
<tr>
<td>defaultDomains</td>
<td>Array</td>
<td>False</td>
<td>[]</td>
<td>Default domains that should be displayed once `@` is typed.</td>
</tr>
<tr>
<td>initialValue</td>
<td>String</td>
<td>False</td>
<td>""</td>
<td>Initial value for the email field.</td>
</tr>
<tr>
<td>maxSuggestions</td>
<td>Number</td>
<td>False</td>
<td>4</td>
<td>How many domain suggestions should displayed.</td>
</tr>
</tbody>
</table>

## Project setup

```
npm install
```

### Compiles and hot-reloads for development

```
npm run serve
```

### Compiles and minifies for production

```
npm run build
```

### Run your unit tests

```
npm run test:unit
```

### Lints and fixes files

```
npm run lint
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).

0 comments on commit d9499ec

Please sign in to comment.