summaryrefslogtreecommitdiff
path: root/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/addonprovider.md
blob: 41ea5500b5a134b0a1e9ee1469b0bd8050bef195 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<!-- 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>