@@ -35,34 +35,36 @@ keyDown(key){
3535
3636The back and custom key will pass a sting, either ` "back" ` or ` "custom" ` to the keyDown callback.
3737
38- The ` <PinKeyboard /> ` also has a number of functions which can be triggered through refs.
38+ The ` <VirtualKeyboard /> ` also has a number of functions which can be triggered through refs.
3939
4040 - ` displayMessage(message) ` this will create a popup above the
4141keyboard displaying the given a message. The style of the popup can be customized through props.
4242 - ` clearMessage() ` this will clear the keyboard message dialog.
4343 - ` enable() ` this will enable the keyboard for input.
4444 - ` disable() ` this will disable the keyboard.
4545
46- #### PinKeyboard
46+ #### VirtualKeyboard
4747
48- The ` <PinKeyboard /> ` uses two arrays to allow you to set keys and define custom functions for each key.
48+ The ` <VirtualKeyboard /> ` uses two arrays to allow you to set keys and define custom functions for each key.
4949
5050| Prop | Type | Optional | Default | Description |
5151| --------------- | ------------- | --------- | -------------------- | --------------------------------------------------------------------------------------- |
5252| onRef | any | No | | onRef allows you to call the ` throwError(message) ` method. |
53- | keyDown | function | No | | Callback function triggered when a key is pressed. Returns the key value. |
54- | keyboard | array | Yes | See PinKeyboard.js | 4 x 3 matrix containing the value for each key. See PinKeyboard.js. |
55- | keyboardFunc | array | Yes | See PinKeyboard.js | 4 x 3 matrix containing custom functions for each key. Pass null for no function. |
53+ | onKeyDown | function | Yes | | Callback function triggered when a key is pressed. Returns the key value. |
54+ | onChange | function | Yes | | Callback function triggered when a key is pressed. Returns the full string. |
55+ | onCustomKey | function | Yes | | Callback function triggered when custom left button is pressed, use with ` onChange ` |
56+ | keyboard | array | Yes | See VirtualKeyboard.js | 4 x 3 matrix containing the value for each key. See VirtualKeyboard.js. |
57+ | keyboardFunc | array | Yes | See VirtualKeyboard.js | 4 x 3 matrix containing custom functions for each key. Pass null for no function. |
5658| keyboardCustomKeyImage | number | Yes | null | Image for the custom key (bottom left key) |
5759| keyboardMessageDisplayTime | number | Yes | 3000 | Time in milliseconds for the message dialog to automatically clear. |
5860| vibration | bool | Yes | false | Key / Tactile vibration enabled |
59- | keyboardStyle | object | Yes | See PinKeyboard .js | Style applied to the keyboard. |
60- | keyboardDisabledStyle | object | Yes | See PinKeyboard .js | Style applied when the keyboard is disabled. |
61- | keyStyle | object | Yes | See PinKeyboard .js | Style applied to each key on the keyboard. |
62- | keyTextStyle | object | Yes | See PinKeyboard .js | Style applied to the text inside each key. |
63- | keyImageStyle | object | Yes | See PinKeyboard .js | Style applied to image in a key. If an image is passed. |
64- | messageStyle | object | Yes | See PinKeyboard .js | Style applied to popup error. Can set the background colour here. |
65- | messageTextStyle| object | Yes | See PinKeyboard .js | Style applied to the text inside the popup error.
61+ | keyboardStyle | object | Yes | See VirtualKeyboard .js | Style applied to the keyboard. |
62+ | keyboardDisabledStyle | object | Yes | See VirtualKeyboard .js | Style applied when the keyboard is disabled. |
63+ | keyStyle | object | Yes | See VirtualKeyboard .js | Style applied to each key on the keyboard. |
64+ | keyTextStyle | object | Yes | See VirtualKeyboard .js | Style applied to the text inside each key. |
65+ | keyImageStyle | object | Yes | See VirtualKeyboard .js | Style applied to image in a key. If an image is passed. |
66+ | messageStyle | object | Yes | See VirtualKeyboard .js | Style applied to popup error. Can set the background colour here. |
67+ | messageTextStyle| object | Yes | See VirtualKeyboard .js | Style applied to the text inside the popup error.
6668
6769## Contributing
6870
0 commit comments