simple-keyboard - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "simple-keyboard",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "React.js Virtual Keyboard",
@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

@@ -122,2 +122,59 @@ # simple-keyboard
 
+### newLineOnEnter
+
+> Specifies whether clicking the "ENTER" button will input a newline (`\n`) or not.
+
+```js
+newLineOnEnter={true}
+```
+
+## Methods
+
+simple-keybord has a few methods you can use to further control it's behavior.
+To access these functions, you need a `ref` of the simple-keyboard component, like so:
+
+```js
+<Keyboard
+  ref={r => this.keyboard = r}
+  [...]
+/>
+
+// Then, on componentDidMount ..
+this.keyboard.methodName(params);
+```
+
+### clearInput
+
+> Clear the keyboard's input.
+
+```js
+this.keyboard.clearInput();
+```
+
+### getInput
+
+> Get the keyboard's input (You can also get it from the _onChange_ prop).
+
+```js
+let input = this.keyboard.getInput();
+```
+
+### setInput
+
+> Set the keyboard's input. Useful if you want the keybord to initialize with a default value, for example.
+
+```js
+this.keyboard.setInput("Hello World!");
+```
+
+It returns a promise, so if you want to run something after it's applied, call it as so:
+
+```js
+let inputSetPromise = this.keyboard.setInput("Hello World!");
+
+inputSetPromise.then((result) => {
+  console.log("Input set");
+});
+```
+
 ## Demo
@@ -124,0 +181,0 @@

No alert changes

Improved metrics

Total package byte prevSize

66924

increased by1.73%

Number of lines in readme file

194

increased by41.61%

No dependency changes