Wondering what’s next for npm?Check out our public roadmap! »

    use-keyboard-shortcut

    1.0.6 • Public • Published

    useKeyboardShortcut

    npm version

    Click here for a small demo!

    A custom React hook that allows adding keyboard shortcuts to a React application.

    import React from 'react'
    import useKeyboardShortcut from 'use-keyboard-shortcut'
    
    const App = () => {
      useKeyboardShortcut(['Shift', 'H'], () => console.log('Shift + H has been pressed.'), { overrideSystem: false })
    
      return (
        <div>Hello World</div>
      )
    }

    For another example on how to use this hook, please see the example project

    Documentation

    useKeyboardShortcut(keysArray, callback)

    keysArray should be an array of KeyboardEvent.key strings. A full list of strings can be seen here

    callback should be a function that is called once the keys have been pressed.

    options an object containing some configuration options.

    Options

    A list of possible options to put in the options object passed as the third parameters to the hook.

    overrideSystem overrides the default browser behavior for that specific keyboard shortcut

    Bugs / Problems

    Please create an issue.

    Install

    npm i use-keyboard-shortcut

    DownloadsWeekly Downloads

    669

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    13.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar