@types/mousetrap

What is @types/mousetrap?

@types/mousetrap provides TypeScript definitions for the Mousetrap library, which is a simple library for handling keyboard shortcuts in web applications.

What are @types/mousetrap's main functionalities?

Binding a single key

This feature allows you to bind a single key to a specific callback function. In this example, pressing the 'A' key will trigger a console log.

Mousetrap.bind('a', function() { console.log('A key was pressed'); });

Binding multiple keys

This feature allows you to bind multiple keys to a single callback function. In this example, pressing either the 'A' or 'B' key will trigger a console log.

Mousetrap.bind(['a', 'b'], function(e) { console.log('A or B key was pressed'); });

Binding key combinations

This feature allows you to bind key combinations to a callback function. In this example, pressing 'Ctrl+S' will prevent the default browser action and trigger a console log.

Mousetrap.bind('ctrl+s', function(e) { e.preventDefault(); console.log('Save command'); });

Unbinding keys

This feature allows you to unbind a previously bound key. In this example, the 'A' key will no longer trigger any callback.

Mousetrap.unbind('a');

Triggering events programmatically

This feature allows you to trigger a key event programmatically. In this example, it will simulate the pressing of the 'A' key.

Mousetrap.trigger('a');

Other packages similar to @types/mousetrap

keymaster

Keymaster is a simple micro-library for defining and dispatching keyboard shortcuts. It is similar to Mousetrap in that it allows for easy binding of keys and key combinations, but it is more lightweight and has fewer features.

hotkeys-js

Hotkeys.js is a robust library for handling keyboard shortcuts. It offers more advanced features compared to Mousetrap, such as scope management and filtering, making it suitable for more complex applications.

keyboardjs

KeyboardJS is a library for handling keyboard input. It provides more advanced features like key sequences and key state tracking, making it more powerful but also more complex than Mousetrap.

README

Installation

npm install --save @types/mousetrap

Summary

This package contains type definitions for mousetrap (http://craig.is/killing/mice).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mousetrap.

Additional Details

• Last updated: Wed, 22 Nov 2023 00:24:48 GMT
• Dependencies: none

Credits

These definitions were written by Dániel Tar, Alan Choi, Nic Barker, and Piotr Błażejewicz.