diff options
Diffstat (limited to 'lib/mousetrap/plugins/pause/README.md')
| -rw-r--r-- | lib/mousetrap/plugins/pause/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/mousetrap/plugins/pause/README.md b/lib/mousetrap/plugins/pause/README.md new file mode 100644 index 0000000..0b3b3bd --- /dev/null +++ b/lib/mousetrap/plugins/pause/README.md @@ -0,0 +1,13 @@ +# Pause/unpause + +This extension allows Mousetrap to be paused and unpaused without having to reset keyboard shortcuts and rebind them. + +Usage looks like: + +```javascript +// stop Mousetrap events from firing +Mousetrap.pause(); + +// allow Mousetrap events to fire again +Mousetrap.unpause(); +``` |