Socket
Socket
Sign inDemoInstall

react-key-listener

Package Overview
Dependencies
8
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-key-listener

React component for handling keyboard events


Version published
Maintainers
1
Weekly downloads
986
decreased by-8.96%

Weekly downloads

Readme

Source

react-key-listener

React component for handling keyboard events, without interfering with editable fields and buttons. Use this instead of calling addEventListener or adding onKeyDown to elements manually.

Usage

npm install --save react-key-listener

Example:

class MyComponent extends React.Component {
  handleAKey = () => {
    // do something
  };

  render() {
    return (
      <div tabIndex={0 /* allow this div to be given user focus */}>
        <KeyListener keyDownHandlers={{
          a: this.handleAKey
        }} />
      </div>
    );
  }
}

KeyListener ignores key events when the event originated from an <input>, <textarea>, or contenteditable element. This prevents your key event handlers from triggering when the user expected to be typing in a text field.

The event listener is added to the KeyEvent component's parent element.

Props

NameTypeDescription
keyDownHandlers{ [key: string]: (event: KeyboardEvent) => void }event handlers for keydown events. if event.key appears as a property on this object, the corresponding handler will be called
keyPressHandlers{ [key: string]: (event: KeyboardEvent) => void }
keyUpHandlers{ [key: string]: (event: KeyboardEvent) => void }
globaltrue | falseif true, listen to events on document; if false, listen on the KeyListener's parent element

FAQs

Last updated on 06 May 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc