summaryrefslogtreecommitdiff
path: root/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md
diff options
context:
space:
mode:
authorRuben Rodriguez <ruben@gnu.org>2018-09-13 20:39:48 -0400
committerRuben Rodriguez <ruben@gnu.org>2018-09-13 21:02:13 -0400
commitd26b319fd6f98517cc3421f10bf18698b953e4d2 (patch)
treebc70c4e472a2eaf514d411dba5067d530e5bbea9 /data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md
parentc3b304c51a3386ea09527a479a883253ea35243a (diff)
Updated extensions list for v60
Diffstat (limited to 'data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md')
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md55
1 files changed, 0 insertions, 55 deletions
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
deleted file mode 100644
index 4117827..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md
+++ /dev/null
@@ -1,55 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-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");
- }
- });
-
-<api name="XulKey">
-@class
-
-This module exports a `XulKey` constructor which allows one to create xul based
-hotkeys.
-
-<api name="XulKey">
-@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.
-</api>
-
-</api>