Skip to content

Commit 88226c5

Browse files
author
Marty Wallace
committed
Added README.
1 parent 6ed5354 commit 88226c5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# vue-keyboard
2+
3+
A simple virtual keyboard for Vue.js.
4+
5+
## Usage:
6+
7+
Simply add the `keyboard` component to your Vue application:
8+
9+
```
10+
<keyboard chars="abc123|xyz456|{space:space}"></keyboard>
11+
```
12+
13+
The `chars` property accepts a pipe `|` delimited string of characters to use as the keyboard buttons. You can include special function characters with the `{text:action}` syntax, where `text` is the text that will be rendered in the button and `action` is the action within the keyboard component to be called when that button is pressed. The actions are:
14+
15+
* `backspace` - Remove one character from the end of the current value.
16+
* `space` - Insert one whitespace character.
17+
* `clear` - Clear the entire input value.

0 commit comments

Comments
 (0)