summaryrefslogtreecommitdiff
path: root/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs
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
parentc3b304c51a3386ea09527a479a883253ea35243a (diff)
Updated extensions list for v60
Diffstat (limited to 'data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs')
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon-warning.md0
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon.md28
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addonprovider.md50
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/awesomebar.md61
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/content-policy.md0
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/l10n.md41
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/listen.md23
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/menuitems.md66
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/panic.md45
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/toolbarbutton.md84
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/unload+.md20
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md44
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userstyles.md26
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/xulkeys.md55
14 files changed, 0 insertions, 543 deletions
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon-warning.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon-warning.md
deleted file mode 100644
index e69de29..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon-warning.md
+++ /dev/null
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon.md
deleted file mode 100644
index d75edcc..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addon.md
+++ /dev/null
@@ -1,28 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-
-The `addon` API provides a simple way to create
-Add-on wrapper instances for the [Extension Manager](about:addons).
-
-## Example ##
-
- exports.main = function(options) {
-
- };
-
-<api name="Addon">
-@class
-
-Module exports `Addon` constructor allowing users to create a
-add-on category provider to the Extension Manager.
-
-<api name="Addon">
-@constructor
-Creates a add-on wrapper instance.
-
-@param options {Object}
-Options for the add-on wrapper, with the following parameters:
-
-</api>
-
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addonprovider.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addonprovider.md
deleted file mode 100644
index 41ea550..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addonprovider.md
+++ /dev/null
@@ -1,50 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-
-The `addonprovider` API provides a simple way to create
-new Add-on types for the [Extension Manager](about:addons).
-
-## Example ##
-
- exports.main = function(options) {
-
- };
-
-<api name="AddonProvider">
-@class
-
-Module exports `AddonProvider` constructor allowing users to create a
-add-on category provider to the Extension Manager.
-
-<api name="AddonProvider">
-@constructor
-Creates a add-on provider.
-
-@param options {Object}
-Options for the add-on provider, with the following parameters:
-
-@prop type {String}
-A unique string that will identify the type of add-ons that your provider
-will provide. This is internal users never see it.
-
-@prop localeKey {String}
-A label to be used in the Extension Manager, which users see.
-
-@prop uiPriority {Number}
-A number to represent the order to display your Add-on type in the Extension
-Manager side navigation.
-
-@prop getAddonByID {Function}
-A function that returns the appropriate `Addon`.
-
-@prop getAddons {Function}
-A function that returns the appropriate `Addon`s.
-
-</api>
-
-<api name="destroy">
-@method
-Removes the add-on provider.
-</api>
-
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/awesomebar.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/awesomebar.md
deleted file mode 100644
index dcfbb1f..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/awesomebar.md
+++ /dev/null
@@ -1,61 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-
-The `awesomebar` API provides a simple way to create AwesomeBar suggestions.
-
-## Example ##
-
- // add github search
- AwesomeBarSuggestion({
- icon: self.data.url("github_16.png"),
- matches: /^(?:@[\w\d_-]+|github\s)/i,
- onSearch: function(query, suggest) {
- query = query.trim();
- if (/^github\s/i.test(query)) {
- query = query.replace(/^github\s/i, "");
- suggest({
- title: 'Search Github for: ' + query,
- favicon: self.data.url("github_16.png"),
- url: 'https://github.com/search?q=' + encodeURIComponent(query)
- }, true);
- } else {
- var username = query.match(/^@([\w\d_-]+)/)[1];
- suggest({
- title: 'Github user: ' + username,
- label: "View user profile for @" + username,
- favicon: self.data.url("github_16.png"),
- url: 'https://github.com/' + username
- }, true);
- }
- }
- });
-
-<api name="AwesomeBarSuggestion">
-@class
- A `AwesomeBarSuggestion` constructor is exported, which allows one to create a
- AwesomeBar suggestions.
-
-<api name="AwesomeBarSuggestion">
-@constructor
- Creates a AwesomeBar suggestion handler.
-
-@param options {object}
- Options for the AwesomeBar suggester, with the following parameters:
-
-@prop matches {string}
- A regular expression which is tested againsted the location bar input string.
-
-@prop [icon] {string}
- A URL for a 16x16 icon image.
-
-@prop onSearch {function}
- Function that is invoked when the match pattern matches the location bar input
- string. If will receive too arguments, `query` which is the input string, and
- `suggest` which is a function that can be made to return suggestions.
-</api>
-
-<api name="destroy">
-@method
- Removes the AwesomeBar suggester.
-</api>
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/content-policy.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/content-policy.md
deleted file mode 100644
index e69de29..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/content-policy.md
+++ /dev/null
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/l10n.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/l10n.md
deleted file mode 100644
index 2207d16..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/l10n.md
+++ /dev/null
@@ -1,41 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `l10n` module allows one to localize their Jetpack.
-
-## Example ##
-
- var _ = require("l10n").l10n({
- filename: "text.properties",
- baseURL: require("self").data.url("locale")
- });
- console.log(_("hello.world"));
-
-<api name="l10n">
-@function
- Creates and returns a function which can be used to access translations by
- key.
-
- Translations should be grouped together in a folder which contains a folder
- for each locale being supported whose name is the locale being supported
- (examples: "en", "en-US", "ja", "ja-JP"). Inside each locale's folder should
- be a `.properties` file with a name that is the same for every locale. Here
- is a example of how you might organize things:
-
- - data/
- - locale/
- - en/
- - text.properties
- - ja/
- - text.properties
-
-@param options {object}
-
-
-@prop filename {string}
- The name of the file storing the translations.
-@prop baseURL {string}
- The url to the folder containing the locale folders.
-@prop [defaultLocale] {string}
- Defines the locale to use when you don't have translations for the user's
- locale. The default is `"en"`.
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/listen.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/listen.md
deleted file mode 100644
index d19c6c6..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/listen.md
+++ /dev/null
@@ -1,23 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `listen` module allows modules to register listeners to elements that are
-automatically removed when the module unloads.
-
-<api name="listen">
-@function
- Add listeners to run when unloading in a unload queue. Optionally scope the
- callback to a container, e.g., window. Provide a way to run all the callbacks.
-
-@param container {object}
- A container for the node, which a "unload" event will be attached to, this is
- used to cancel the unload magic that would occur, to avoid memory leaks.
-@param node {object}
- The node to listen to.
-@param event {string}
- The event type, for example: "load", "click", ...
-@param callback {function}
- A function to be called when the event occurs on the node.
-@param [capture] {boolean}
- Indicates if the event should be captured. [See the `useCapture`
- documentation here](https://developer.mozilla.org/en/DOM/element.addEventListener).
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/menuitems.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/menuitems.md
deleted file mode 100644
index 2017c9c..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/menuitems.md
+++ /dev/null
@@ -1,66 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-
-The `menuitems` API is a simple way to create
-[Menuitems](https://developer.mozilla.org/en/XUL/PopupGuide/MenuItems), which
-can perform an action when clicked, and display state.
-
-## Example ##
-
- exports.main = function(options) {
- // create menuitem for the File menu,
- // and insert it before the 'Quit' menuitem
- require("menuitems").Menuitem({
- id: "myextprefix-some-mi-id",
- menuid: "menu_FilePopup",
- insertbefore: "menu_FileQuitItem",
- "label": _("label"),
- "accesskey": _("label.ak"),
- image: self.data.url("icon.png"),
- className: 'pizazz',
- disabled: false,
- checked: false,
- onCommand: function() {
- // do something
- }
- });
- };
-
-<api name="Menuitem">
-@class
-
-Module exports `Menuitem` constructor allowing users to create a
-[`menuitem`](https://developer.mozilla.org/en/XUL/menuitem).
-
-<api name="Menuitem">
-@constructor
-Creates a `menuitem`.
-
-@param options {Object}
- Options for the `menuitem`, with the following parameters:
-
-@prop id {String}
-A id for the `menuitem`, this should be namespaced.
-
-@prop menuid {String}
-The id of the parent `<menu>` node.
-
-@prop label {String}
-A label for the `menuitem`.
-
-@prop image {String}
-A image url for the `menuitem`.
-
-@prop className {String}
-A default space delimited list of class names for the menuitem.
-
-@prop disabled {Boolean}
-When a menuitem is disabled it cannot be used, but is still displayed.
-
-@prop checked {Boolean}
-Displays a check beside the menuitem.
-
-@prop [onCommand] {Function}
- A option function that is invoked when the `menuitem` is executed.
-</api>
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/panic.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/panic.md
deleted file mode 100644
index 3155341..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/panic.md
+++ /dev/null
@@ -1,45 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `panic` API provides a simple way to create a panic, which
-can be used to anything that is desired in a panic situation, like entering
-private browsing mode, closing/replacing/hiding tabs, or anything else you
-can imagine.
-
-## Example ##
-
- // create a panic that lasts 5 mins
- require('panic').panic(5*60*1000);
-
-<api name="inPanic">
-@property {boolean}
- This read-only boolean is true if there is a panic going on.
-</api>
-
-<api name="panic">
-@function
- Starts a panic.
-@param milliseconds {Number}
- Optional number of milliseconds that the panic should last for, this would
- be useful if you want ensure that certain things are but on hold until the
- panic subsides.
-</api>
-
-<api name="start">
-@event
-Emitted immediately after a panic begins
-
- var panic = require('panic');
- panic.on("start", function() {
- // Do something when a panic starts
- });
-</api>
-
-<api name="end">
-@event
-Emitted immediately after the panic ends
-
- var panic = require('panic');
- panic.on("start", function() {
- // Do something when a panic ends
- });
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/toolbarbutton.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/toolbarbutton.md
deleted file mode 100644
index 87f4cf2..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/toolbarbutton.md
+++ /dev/null
@@ -1,84 +0,0 @@
-The `toolbarbutton` API provides a simple way to create
-[toolbar buttons](https://developer.mozilla.org/en/XUL/toolbarbutton), which
-can perform an action when clicked.
-
-## Example ##
-
- // create toolbarbutton
- var tbb = require("toolbarbutton").ToolbarButton({
- id: "TBB-TEST",
- label: "TBB TEST",
- onCommand: function () {
- tbb.destroy(); // kills the toolbar button
- }
- });
-
- if (require('self').loadReason == "install") {
- tbb.moveTo({
- toolbarID: "nav-bar",
- forceMove: false // only move from palette
- });
- }
-
-<api name="ToolbarButton">
-@class
-
-Module exports `ToolbarButton` constructor allowing users to create a
-toolbar button.
-
-<api name="ToolbarButton">
-@constructor
-Creates a toolbarbutton.
-
-@param options {Object}
- Options for the toolbarbutton, with the following parameters:
-
-@prop id {String}
-A id for the toolbar button, this should be namespaced.
-
-@prop label {String}
-A label for the toolbar button.
-
-@prop image {String}
-A image url for the toolbar button.
-
-@prop [onCommand] {Function}
- A option function that is invoked when the toolbar button is pressed.
-
-@prop [panel] {Panel}
- A optional panel.
-</api>
-
-<api name="destroy">
-@method
-Removes the toolbar button from all open windows and no longer adds the
-toolbar button to new windows.
-</api>
-
-<api name="moveTo">
-@method
-Moves the toolbar button on all open windows to the desired location.
-
-@param options {Object}
-Options which describe the position to move the toolbar button to, with the
-following parameters:
-
-@prop toolbarID {String}
-The id of the toolbar which you want to add the toolbar button to.
-
-Example toolbar IDs:
-
-- **toolbar-menubar**: The menu bar.
-- **nav-bar**: The navigation bar.
-- **TabsToolbar**: The tabs bar.
-- **addon-bar**: The addon bar.
-
-@prop insertbefore {String}
-The id of the element which the toolbar button should be inserted before.
-
-@prop forceMove {Boolean}
-If `forceMove` is `false`, then the move will only occur if the toolbar button
-is not already being used. If `true`, then the move will happen no matter where
-the toolbar button is.
-</api>
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/unload+.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/unload+.md
deleted file mode 100644
index 78693ef..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/unload+.md
+++ /dev/null
@@ -1,20 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `unload+` module allows modules to register callbacks that are called
-when they are unloaded, and associate unload functions to containers to have the
-unloader automatically deleted when the container unloads.
-
-<api name="unload">
-@function
- Save callbacks to run when unloading in a unload queue. Optionally scope the
- callback to a container, e.g., window. Provide a way to run all the callbacks.
-
-@param callback {function}
- A function to be called when the module unloads.
-@param [container] {object}
- Optional container object; if the container "unloads" before the module
- unloads, then the associated callback is removed from the unload queue.
-@returns {function}
- Returns a function which will allow one to remove the callback from the unload
- queue.
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md
deleted file mode 100644
index 1bc8d4e..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md
+++ /dev/null
@@ -1,44 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `userscript` module allows modules to create user scripts which automatically
-start running on windows opened after the user script is created.
-
-
-## Example ##
- var scripts = ["test.user.js"];
- var self = require("self");
- var {UserScript} = require("userscript");
- exports.main = function() {
- scripts.forEach(function(scriptName, index) {
- UserScript(self.data.url(scriptName));
- });
- };
-
-
-<api name="UserScript">
-@class
-
-The module exports a `UserScript` constructor which allowing one to create a
-user script.
-
-<api name="UserScript">
-@constructor
-Creates a user script.
-
-@param aURL {String}
- The url of a user script on the local file system, so this url can be a
- `resource:`, `file:`, or `chrome:` for example.
-</api>
-
-<api name="enabled">
-@property {Boolean}
-Allows one to get and change the status of the a user script. A disabled user
-script will not be injected in to newly opened windows.
-</api>
-
-<api name="destroy">
-@method
-The user script will no longer be injected into new windows, you will have to
-create a new user script in order to run the script again.
-</api>
-</api>
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userstyles.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userstyles.md
deleted file mode 100644
index 7debf98..0000000
--- a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userstyles.md
+++ /dev/null
@@ -1,26 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `userstyles` module allows one to load css/userstyles for content or chrome
-pages.
-
-## Example ##
-
- // loads a user stylesheet
- require("userstyles").load(require("self").data.url("style.css"));
-
-<api name="load">
-@function
- Loads css (aka userstyles) to the browser which will be automatically removed
- when the add-on unloads.
-
-@param url {string}
- The url of a css file.
-
-@param options {object}
- Some options for the stylesheet.
-
-@prop type {String}
- The type for the stylesheet, there are two types 'agent' and 'user'.
- The default should be used when possible, which is 'user'.
-
-</api>
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>