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

    byron-iohook
    TypeScript icon, indicating that this package has built-in type declarations

    1.7.8 • Public • Published

    iohook

    Build status Build Status Gitter chat NPM version

    About

    Node.js global native keyboard and mouse listener.

    This module can handle keyboard and mouse events via native hooks inside and outside your JavaScript/TypeScript application.

    Found a bug? Have an idea? Feel free to post an issue or submit a PR.

    Check out the documentation.

    Platform support

    • Versions >= 0.6.0 support only officially supported platforms versions.
    • Versions 0.5.X are the last to support Electron < 4.0.0
    • Versions 0.4.X are the last to support for Node < 8.0 and Electron < 2.0.0

    Installation

    iohook provides prebuilt version for a bunch of OSes and platforms.

    Linux (including WSL)

    # On Linux (including WSL) platform, you will need libxkbcommon-x11 installed
    sudo apt-get install -y libxkbcommon-x11-0

    All platforms

    npm install iohook --save # or yarn add iohook

    FAQ

    Q. Does this module require Java ?

    A. No, this module doesn't require Java (like jnativehook) or any other runtimes.

    Q. Is iohook compatible with Node/Electron version X.Y.Z ?

    A. We try to match the currently supported version of both Node and Electron.

    Apps

    Are you using iohook in your project ? Please tell us in a PR so we an add it to the list !

    Contributors

    Thanks to kwhat for the libuiohook project and ayoubserti for the first iohook prototype.

    • vespakoen (prebuild system implementation)
    • matthewshirley (Windows prebuild fix)
    • djiit (project & community help)
    • ezain (add feature enable/disable mouse click propagation)
    • anoadragon453 (electron 4+ support)
    • ykhwong (node-gyp usage, electron 9+ support)
    • All the other contributors. Feel free to extend this list !

    Install

    npm i byron-iohook

    DownloadsWeekly Downloads

    10

    Version

    1.7.8

    License

    MIT

    Unpacked Size

    62.4 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar