# react-onscreen-keyboard

> A completely customisable 0 dependency react onscreen keyboard.

Latest version **1.0.0** (published 2018-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-onscreen-keyboard
pnpm add react-onscreen-keyboard
yarn add react-onscreen-keyboard
bun add react-onscreen-keyboard
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-10-20 |
| First published | 2018-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | rakannimer |

## Links

- npm: https://www.npmjs.com/package/react-onscreen-keyboard
- Repository: https://github.com/rakannimer/react-onscreen-keyboard
- Homepage: https://github.com/rakannimer/react-onscreen-keyboard#readme
- Issues: https://github.com/rakannimer/react-onscreen-keyboard/issues
- npm.io page: https://npm.io/package/react-onscreen-keyboard

## Recent versions

- 1.0.0 (latest) — 2018-10-20

## README

## React On Screen Keyboard

A completely customisable react on screen keyboard.

[![CircleCI][circleci-badge]][circleci-href]
[![NPM][npm-version-badge]][npm-href]
[![BundlePhobia][bundlephobia-badge]][bundlephobia-href]

![React On Screen Keyboard Demo](/example.png)

## Install

```sh
  yarn add react-onscreen-keyboard
  # Or
  npm i react-onscreen-keyboard
```

## Usage

```jsx
import * as ReactDOM from "react-dom";
import * as React from "react";
import Keyboard from "react-onscreen-keyboard";

ReactDOM.render(
  <Keyboard
    width={900}
    keyStyle={{
      background: "rgba(0,12,12,0.3)",
      borderRadius: "50%"
    }}
  />,
  document.getElementById("app")
);
```

## Props

- width?: number
- height?: number;
- keyWidth?: number;
- rowHeightPercent?: number;
- rowWidthPercent?: number;
- verticalMargin?: number;
- horizontalMargin?: number;
- overrides?: Map<string, (p: KeyboardKeyProps) => JSX.Element>;
- keyboardKeys?: KeyboardKeyVal[][];
- renderKey?: (p: KeyboardKeyProps) => JSX.Element;
- rowStyle?: React.CSSProperties;
- keyStyle?: React.CSSProperties;

[circleci-href]: https://circleci.com/gh/rakannimer/react-onscreen-keyboard
[circleci-badge]: https://img.shields.io/circleci/project/github/rakannimer/react-onscreen-keyboard.svg
[npm-href]: https://www.npmjs.com/package/react-onscreen-keyboard
[npm-version-badge]: https://badgen.net/npm/v/react-onscreen-keyboard
[bundlephobia-badge]: https://img.shields.io/bundlephobia/minzip/react-onscreen-keyboard.svg
[bundlephobia-href]: https://bundlephobia.com/result?p=react-onscreen-keyboard

---
_Source: https://npm.io/package/react-onscreen-keyboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._