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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
<!-- 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>
|
