React Setup

Getting Started

Installation

npm install react-simple-keyboard --save

Usage

Demos: View Demo

Usage with React Hooks / Function components

React Hooks compatibility has landed as of version 2.x. Most demos however are still in the form of class components. If you’d like to integrate react-simple-keyboard in a function component, check out this demo:

Demos: View Demo

Usage with Typescript

Types are included in react-simple-keyboard. For an example, check out the following demos:

For Typescript + React Hooks :

Demos: View Demo

For Typescript + Class Components:

Demos: View Demo

Usage with Preact and/or Preact-compat

If you run into issues using react-simple-keyboard with Preact and/or Preact-compat, please use the core simple-keyboard.

Demos: View Demo

Usage with Gatsby and similar static site generators (SSR)

If you are using Gatsby or similar static site generators, it’s recommended to use the core simple-keyboard package instead.

Demos: View Demo

More demos

Multi-platform showcase