was-keypress-enter

A simple function to check if a keypress was the return/enter key. The function takes an event and returns a boolean.

Usage no npm install needed!

<script type="module">
  import wasKeypressEnter from 'https://cdn.skypack.dev/was-keypress-enter';
</script>

README

was-keypress-enter (Node package)

Build Status Coverage Status

A function to check if a keypress was the return/enter key (either on the numpad or the main keyboard). The function takes an event (generated by a keypress for example) and returns a boolean.

Usage Example in the browser

<input type="text" id="input-field-one" />

document.getElementById('input-field-one').addEventListener('keydown', function(e) {
  if(wasKeypressEnter(e)) {
    // enter was pressed
  }
  else {
    // a key was pressed but it wasn't enter
  }
});

Usage example in react

import wasKeypressEnter from 'was-keypress-enter';

export class CustomUserInput extends React.Component {

    constructor(props) {
      super();
    }
    
    handleClick(e) {
      //the element was clicked
    }
    
    handleKeyPress(e) {
      if(wasKeypressEnter(e) {
        //the keypress was the enter key - do something
      }
    }
    
    render() {
      return (
        <CustomComponent tabIndex="0" onClick={this.handleClick} onKeyPress={this.handleKeyPress} />
      );
    }
}