react-keymaster

React component to listen to keydown and keyup keyboard events

Usage no npm install needed!

<script type="module">
  import reactKeymaster from 'https://cdn.skypack.dev/react-keymaster';
</script>

README

react-keymaster

A react component that listens to KeyDown And KeyUp event. Uses a fork of keymaster for keydown detection of special characters.

Example

Install

yarn add react-keymaster

Code

import React from "react";
import ReactKeymaster from "react-keymaster";
class Demo extends React.Component {
  state = {
    output: "Hello, I am a component that listens to keydown and keyup of a"
  };
  render() {
    return (
      <div>
        <h1>react-keymaster demo</h1>
        <ReactKeymaster
          keyName="a"
          onKeyDown={keyname => {
            this.setState({
              output: `keyup ${keyName}`
            });
          }}
          onKeyUp={keyName => {
            this.setState({
              output: `keyup ${keyName}`
            });
          }}
        />
        <div>{this.state.output}</div>
      </div>
    );
  }
}