| blob | cb5f6989b751c3cbc7e02e38077a6ee6246135aa |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 [
6 {
7 "namespace": "contextMenus",
8 "description": "Use the <code>chrome.contextMenus</code> API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.",
9 "functions": [
10 {
11 "name": "create",
12 "type": "function",
13 "description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.runtime.lastError).",
14 "returns": {
15 "choices": [
16 { "type": "integer" },
17 { "type": "string" }
18 ],
19 "description": "The ID of the newly created item."
20 },
21 "parameters": [
22 {
23 "type": "object",
24 "name": "createProperties",
25 "properties": {
26 "type": {
27 "type": "string",
28 "enum": ["normal", "checkbox", "radio", "separator"],
29 "optional": true,
30 "description": "The type of menu item. Defaults to 'normal' if not specified."
31 },
32 "id": {
33 "type": "string",
34 "optional": true,
35 "description": "The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension."
36 },
37 "title": {
38 "type": "string",
39 "optional": true,
40 "description": "The text to be displayed in the item; this is <em>required</em> unless <em>type</em> is 'separator'. When the context is 'selection', you can use <code>%s</code> within the string to show the selected text. For example, if this parameter's value is \"Translate '%s' to Pig Latin\" and the user selects the word \"cool\", the context menu item for the selection is \"Translate 'cool' to Pig Latin\"."
41 },
42 "checked": {
43 "type": "boolean",
44 "optional": true,
45 "description": "The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items."
46 },
47 "contexts": {
48 "type": "array",
49 "items": {
50 "type": "string",
51 "enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio", "launcher"]
52 },
53 "minItems": 1,
54 "optional": true,
55 "description": "List of contexts this menu item will appear in. Defaults to ['page'] if not specified. Specifying ['all'] is equivalent to the combination of all other contexts except for 'launcher'. The 'launcher' context is only supported by apps and is used to add menu items to the context menu that appears when clicking on the app icon in the launcher/taskbar/dock/etc. Different platforms might put limitations on what is actually supported in a launcher context menu."
56 },
57 "onclick": {
58 "type": "function",
59 "optional": true,
60 "description": "A function that will be called back when the menu item is clicked. Event pages cannot use this; instead, they should register a listener for chrome.contextMenus.onClicked.",
61 "parameters": [
62 {
63 "name": "info",
64 "$ref": "contextMenusInternal.OnClickData",
65 "description": "Information about the item clicked and the context where the click happened."
66 },
67 {
68 "name": "tab",
69 "$ref": "tabs.Tab",
70 "description": "The details of the tab where the click took place."
71 }
72 ]
73 },
74 "parentId": {
75 "choices": [
76 { "type": "integer" },
77 { "type": "string" }
78 ],
79 "optional": true,
80 "description": "The ID of a parent menu item; this makes the item a child of a previously added item."
81 },
82 "documentUrlPatterns": {
83 "type": "array",
84 "items": {"type": "string"},
85 "optional": true,
86 "description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see <a href='match_patterns.html'>Match Patterns</a>."
87 },
88 "targetUrlPatterns": {
89 "type": "array",
90 "items": {"type": "string"},
91 "optional": true,
92 "description": "Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags."
93 },
94 "enabled": {
95 "type": "boolean",
96 "optional": true,
97 "description": "Whether this context menu item is enabled or disabled. Defaults to true."
98 }
99 }
100 },
101 {
102 "type": "function",
103 "name": "callback",
104 "optional": true,
105 "description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.runtime.lastError.",
106 "parameters": []
107 }
108 ]
109 },
110 {
111 "name": "update",
112 "type": "function",
113 "description": "Updates a previously created context menu item.",
114 "parameters": [
115 {
116 "choices": [
117 { "type": "integer" },
118 { "type": "string" }
119 ],
120 "name": "id",
121 "description": "The ID of the item to update."
122 },
123 {
124 "type": "object",
125 "name": "updateProperties",
126 "description": "The properties to update. Accepts the same values as the create function.",
127 "properties": {
128 "type": {
129 "type": "string",
130 "enum": ["normal", "checkbox", "radio", "separator"],
131 "optional": true
132 },
133 "title": {
134 "type": "string",
135 "optional": true
136 },
137 "checked": {
138 "type": "boolean",
139 "optional": true
140 },
141 "contexts": {
142 "type": "array",
143 "items": {
144 "type": "string",
145 "enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio", "launcher"]
146 },
147 "minItems": 1,
148 "optional": true
149 },
150 "onclick": {
151 "type": "function",
152 "optional": true
153 },
154 "parentId": {
155 "choices": [
156 { "type": "integer" },
157 { "type": "string" }
158 ],
159 "optional": true,
160 "description": "Note: You cannot change an item to be a child of one of its own descendants."
161 },
162 "documentUrlPatterns": {
163 "type": "array",
164 "items": {"type": "string"},
165 "optional": true
166 },
167 "targetUrlPatterns": {
168 "type": "array",
169 "items": {"type": "string"},
170 "optional": true
171 },
172 "enabled": {
173 "type": "boolean",
174 "optional": true
175 }
176 }
177 },
178 {
179 "type": "function",
180 "name": "callback",
181 "optional": true,
182 "parameters": [],
183 "description": "Called when the context menu has been updated."
184 }
185 ]
186 },
187 {
188 "name": "remove",
189 "type": "function",
190 "description": "Removes a context menu item.",
191 "parameters": [
192 {
193 "choices": [
194 { "type": "integer" },
195 { "type": "string" }
196 ],
197 "name": "menuItemId",
198 "description": "The ID of the context menu item to remove."
199 },
200 {
201 "type": "function",
202 "name": "callback",
203 "optional": true,
204 "parameters": [],
205 "description": "Called when the context menu has been removed."
206 }
207 ]
208 },
209 {
210 "name": "removeAll",
211 "type": "function",
212 "description": "Removes all context menu items added by this extension.",
213 "parameters": [
214 {
215 "type": "function",
216 "name": "callback",
217 "optional": true,
218 "parameters": [],
219 "description": "Called when removal is complete."
220 }
221 ]
222 }
223 ],
224 "events": [
225 {
226 "name": "onClicked",
227 "type": "function",
228 "$ref": "contextMenusInternal.onClicked"
229 }
230 ]
231 }
232 ]