/keybored

React-based keyboard UI library 💬

Primary LanguageJavaScriptMIT LicenseMIT

keybored

npm bundlephobia bundlephobia npm npm

React-based keyboard UI library

Support keybored's creator and help support new feature development

Install

$ npm i keybored

Add the CSS file to your project

Basic Usage

import Keybored from 'keybored';
import './keybored.css';

Keybored({
  whatKey: false,
  keyboard: 'std',
  function: (key) => {
    console.log(key); // basic keypress logging function
  },
});

const App = () => {
  return <div className="App"></div>;
};

export default App;

Documentation

View full documentation at keyboredjs.com

Want to contribute?

keybored is an open-source project, submit a PR! Any help, ideas, etc. is appreciated.