Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
icebob committed Oct 25, 2016
1 parent 3b6f746 commit 48719b9
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Virtual keyboard component for Vue.js v1.x.x. Designed to Raspberry Pi Touch Dis
[![Screenshot](https://cloud.githubusercontent.com/assets/306521/19689897/2945a008-9acf-11e6-962f-915eddda0cf4.png)](https://jsfiddle.net/icebob/88n7c1L8/)

## Features
- multiple layout
- no dependencies
- 3 built-in layouts, but you can create custom layouts
- **no external dependencies**
- full responsive
- customizable styles
- ...etc
Expand Down Expand Up @@ -83,6 +83,21 @@ https://github.com/icebob/vue-touch-keyboard/archive/master.zip
</script>
```

## Properties
Property | Default | Accepted values | Description
------------- | -------- | --------------- | -----------
`input` | `null` | `HTMLInputElement` |
`layout` | `null` | `String` or `Object` |
`accept` | `null` | `Function` |
`cancel` | `null` | `Function` |
`change` | `null` | `Function` |
`options` | `{}` | `Object` |

## Built-in layouts
* `normal` - Normal full layout. Similar as real keyboard layouts
* `numeric` - Only for numbers
* `compact` - Compact layout. Similar as mobile phone keyboard layouts

## Development
This command will start a `webpack-dev-server` with content of `dev` folder.
```bash
Expand Down

0 comments on commit 48719b9

Please sign in to comment.