From e4a3586a14996bbece3b26c9e3b7704ea6af8615 Mon Sep 17 00:00:00 2001 From: Ruben Rodriguez Date: Sat, 28 Nov 2015 15:24:36 -0600 Subject: LibreJS upgraded to 6.0.10 --- .../node_modules/pathfinder/docs/xulkeys.md | 55 ++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md (limited to 'data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md') diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md new file mode 100644 index 0000000..4117827 --- /dev/null +++ b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md @@ -0,0 +1,55 @@ + + +Some add-ons may wish to define keyboard shortcuts for certain operations. This +module exposes an API to create +[xul based hotkeys](https://developer.mozilla.org/en/XUL/key). + +## Example ## + + var keyID = "ADDON:EXAMPLE-HOTKEY@ERIKVOLD.COM:CMD-ALT-R"; + const { XulKey } = require("xulkeys"); + + XulKey({ + id: keyID, + modifiers: "accel,alt", + key: "R", + onCommand: function() { + console.log("pressed"); + } + }); + + +@class + +This module exports a `XulKey` constructor which allows one to create xul based +hotkeys. + + +@constructor +Creates a hotkey whose `onCommand` listener method is invoked when the key +comboination provided is pressed. + +@param options {Object} + Options that define the hotkey, with the following properties: + +@prop [id] {string} + A namespaced unique id for the key element. +@prop key {string} + The key to listen for. +@prop [modifiers] {string} + A list of modifier keys that should be pressed to invoke the hotkey. + Multiple keys may be separated by spaces or commas. + + "accel" + "meta,shift" + "control alt" + + See the [MDN documentation on the modifiers + attribute](https://developer.mozilla.org/en/XUL/Attribute/modifiers) for a + full list of acceptable values. + +@prop onCommand {function} + A function that is invoked when the hotkey is pressed. + + + -- cgit v1.2.3