diff --git a/README.md b/README.md index 934869b7..70d84b56 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ > The easily customisable and responsive on-screen virtual keyboard for Javascript projects. - + ## Installation @@ -153,12 +153,33 @@ display: { ### theme -> A prop to add your own css classes. You can add multiple classes separated by a space. +> A prop to add your own css classes _to the keyboard wrapper_. You can add multiple classes separated by a space. ```js theme: "hg-theme-default" ``` +### buttonTheme + +> A prop to add your own css classes _to one or several buttons_. You can add multiple classes separated by a space. + +```js +buttonTheme: [ + { + class: "myCustomClass", + buttons: "Q W E R T Y q w e r t y" + }, + { + class: "anotherCustomClass", + buttons: "Q q" + }, + ... +] +``` + +[![Edit simple-keyboard customization demo - npm](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vj8jvz2q4l?module=%2Fsrc%2Findex.js) + + ### debug > Runs a console.log every time a key is pressed. Displays the buttons pressed and the current input. @@ -329,8 +350,6 @@ For example: ## Demo - - [https://franciscohodge.com/simple-keyboard/demo](https://franciscohodge.com/simple-keyboard/demo) [![Edit krzkx19rr](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/krzkx19rr)