forked from mdn/webextensions-examples
-
Notifications
You must be signed in to change notification settings - Fork 0
/
examples.json
560 lines (560 loc) · 18 KB
/
examples.json
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
[
{
"description": "Displays a sidebar that lets you take notes on web pages.",
"javascript_apis": [
"storage.local",
"tabs.onActivated",
"tabs.onUpdated",
"tabs.query",
"windows.getCurrent"
],
"name": "annotate-page"
},
{
"description": "Adds a page action to the toolbar. Click the button to apply a red border using injected CSS. Click the button again to remove the CSS.",
"javascript_apis": [
"pageAction.getTitle",
"pageAction.onClicked",
"pageAction.setIcon",
"pageAction.setTitle",
"pageAction.show",
"tabs.insertCSS",
"tabs.onUpdated",
"tabs.query",
"tabs.removeCSS"
],
"name": "apply-css"
},
{
"description": "Adds a browser action icon to the toolbar. Click the button to choose a beast. The active tab's body content is then replaced with a picture of the chosen beast.",
"javascript_apis": [
"extension.getURL",
"runtime.onMessage",
"tabs.executeScript",
"tabs.insertCSS",
"tabs.query",
"tabs.removeCSS",
"tabs.sendMessage"
],
"name": "beastify"
},
{
"description": "Adds a bookmark button to the toolbar. Click the button to toggle a bookmark for the current page.",
"javascript_apis": [
"bookmarks.create",
"bookmarks.onCreated",
"bookmarks.onRemoved",
"bookmarks.remove",
"bookmarks.search",
"browserAction.onClicked",
"browserAction.setIcon",
"browserAction.setTitle",
"tabs.onActivated",
"tabs.onUpdated",
"tabs.query",
"windows.onFocusChanged"
],
"name": "bookmark-it"
},
{
"description": "Adds a solid red border to all webpages matching mozilla.org.",
"javascript_apis": [],
"name": "borderify"
},
{
"description": "Show a page action after a period of inactivity. Show cat gifs when the page action is clicked.",
"javascript_apis": [
"alarms.clearAll",
"alarms.create",
"alarms.onAlarm",
"pageAction.hide",
"pageAction.onClicked",
"pageAction.show",
"tabs.get",
"tabs.onActivated",
"tabs.onUpdated",
"tabs.query",
"tabs.update"
],
"name": "chill-out"
},
{
"description": "Demonstrates using the commands API to set up a keyboard shortcut. The shortcut created is accessed using Ctrl+Shift+U (Command+Shift+U on a Mac).",
"javascript_apis": [
"commands.getAll",
"commands.onCommand",
"commands.reset",
"commands.update",
"tabs.create"
],
"name": "commands"
},
{
"description": "Add a context menu option to links to copy the link to the clipboard, as plain text and as a link in rich HTML.",
"javascript_apis": [
"contextMenus.create",
"contextMenus.onClicked",
"tabs.executeScript"
],
"name": "context-menu-copy-link-with-types"
},
{
"description": "List, create, and remove contextual identities.",
"javascript_apis": [
"contextualIdentities.query",
"tabs.create",
"tabs.query",
"tabs.remove"
],
"name": "contextual-identities"
},
{
"description": "Allows the user to customize the background color and tiled pattern on sites the visit, and also saves their preferences via a cookie, reapplying them whenever they revisit a site they previously customized.",
"javascript_apis": [
"cookies.get",
"cookies.onChanged",
"cookies.remove",
"cookies.set",
"extension.getURL",
"runtime.onMessage",
"tabs.onActivated",
"tabs.onUpdated",
"tabs.query",
"tabs.sendMessage"
],
"name": "cookie-bg-picker"
},
{
"description": "Demonstrates some of the devtools APIs.",
"javascript_apis": [
"devtools.inspectedWindow",
"devtools.panels",
"runtime.getURL",
"runtime.onMessage",
"runtime.sendMessage",
"tabs.executeScript"
],
"name": "devtools-panels"
},
{
"description": "Demonstrates adding a custom search engine with the chrome_settings_overrides key.",
"javascript_apis": [],
"name": "discogs-search"
},
{
"description": "Dynamic theme example",
"javascript_apis": [
"alarms.create",
"alarms.onAlarm",
"theme.update"
],
"name": "dynamic-theme"
},
{
"description": "Demonstrates how to use an embedded WebExtension to port from a bootstrapped extension.",
"javascript_apis": [
"runtime.onMessage",
"runtime.sendMessage",
"storage.local"
],
"name": "embedded-webextension-bootstrapped"
},
{
"description": "Demonstrates how to use an embedded WebExtension to port from an overlay extension.",
"javascript_apis": [
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "embedded-webextension-overlay"
},
{
"description": "Demonstrates how to use an embedded WebExtension to port from an SDK-based add-on.",
"javascript_apis": [
"notifications.create",
"runtime.connect",
"runtime.onConnect",
"runtime.onMessage",
"runtime.sendMessage",
"storage.local"
],
"name": "embedded-webextension-sdk"
},
{
"description": "Replaces words with emojis.",
"javascript_apis": [],
"name": "emoji-substitution"
},
{
"description": "Demonstrates how to configure an extension with eslint.",
"javascript_apis": [],
"name": "eslint-example"
},
{
"description": "Demonstrates how to use export helpers like cloneInto to share objects with page scripts.",
"javascript_apis": [
"notifications.create",
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "export-helpers"
},
{
"description": "An example options page, letting you store your favourite colour.",
"javascript_apis": [
"browserAction.onClicked",
"runtime.openOptionsPage",
"storage.managed",
"storage.sync"
],
"name": "favourite-colour"
},
{
"description": "Demonstration of the find API.",
"javascript_apis": [
"browserAction.onClicked",
"extension.getBackgroundPage",
"find.find",
"find.highlightResults",
"runtime.getURL",
"runtime.onMessage",
"runtime.sendMessage",
"tabs.create",
"tabs.query"
],
"name": "find-across-tabs"
},
{
"description": "Demonstrates how to use the omnibox API.",
"javascript_apis": [
"omnibox.onInputChanged",
"omnibox.onInputEntered",
"omnibox.setDefaultSuggestion",
"tabs.create",
"tabs.update"
],
"name": "firefox-code-search"
},
{
"description": "Demonstrates how to use the browsingData API.",
"javascript_apis": [
"browserAction.onClicked",
"browsingData.remove",
"notifications.create",
"storage.local"
],
"name": "forget-it"
},
{
"description": "Demonstrates how to use the identity API.",
"javascript_apis": [
"browserAction.onClicked",
"identity.getRedirectURL",
"identity.launchWebAuthFlow",
"notifications.create"
],
"name": "google-userinfo"
},
{
"description": "History API demo: deletes history items for a given domain",
"javascript_apis": [
"history.deleteUrl",
"history.search",
"pageAction.show",
"tabs.onUpdated",
"tabs.query"
],
"name": "history-deleter"
},
{
"description": "Demonstrates how to rewrite HTTP responses using the webRequest.filterResponseData() API.",
"javascript_apis": [
"webRequest.filterResponseData",
"webRequest.onBeforeRequest"
],
"name": "http-response"
},
{
"description": "Using a sidebar, illustrates the use of file picker and drag and drop. A content script replaces the current page content with the chosen image.",
"javascript_apis": [
"extension.getURL",
"runtime.onMessage",
"tabs.executeScript",
"tabs.query",
"tabs.sendMessage"
],
"name": "imagify"
},
{
"description": "Shows the last downloaded item, and lets you open or delete it.",
"javascript_apis": [
"downloads.erase",
"downloads.getFileIcon",
"downloads.open",
"downloads.removeFile",
"downloads.search"
],
"name": "latest-download"
},
{
"description": "This extensions list the cookies in the active tab.",
"javascript_apis": [
"cookies.getAll",
"tabs.query"
],
"name": "list-cookies"
},
{
"description": "Demonstrates adding and manipulating menu items using the menus API.",
"javascript_apis": [
"i18n.getMessage",
"menus.create",
"menus.onClicked",
"menus.remove",
"menus.update",
"runtime.lastError",
"tabs.executeScript"
],
"name": "menu-demo"
},
{
"description": "",
"javascript_apis": [
"menus.create",
"menus.onClicked",
"menus.onShown",
"menus.refresh",
"menus.update",
"tabs.update"
],
"name": "menu-labelled-open"
},
{
"description": "This example shows two methods of testing an extension: running tests from within the extension, and running tests from the command line using Karma",
"javascript_apis": [
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "mocha-client-tests"
},
{
"description": "Example of native messaging, including a Python application and an extension which exchanges messages with it.",
"javascript_apis": [
"browserAction.onClicked",
"runtime.connectNative"
],
"name": "native-messaging"
},
{
"description": "Demonstration of the webNavigation API, showing basic stats about which pages you've visited.",
"javascript_apis": [
"storage.local",
"webNavigation.onCommitted",
"webNavigation.onCompleted"
],
"name": "navigation-stats"
},
{
"description": "Shows a localized notification when the user clicks on links.",
"javascript_apis": [
"extension.getURL",
"i18n.getMessage",
"notifications.create",
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "notify-link-clicks-i18n"
},
{
"description": "Adds a browser action icon to the toolbar. When the browser action is clicked, the add-on opens a page that was packaged with it.",
"javascript_apis": [
"browserAction.onClicked",
"tabs.create"
],
"name": "open-my-page-button"
},
{
"description": "Demonstrates how a web page and a content script can exchange messages. Visit https://mdn.github.io/webextensions-examples/content-script-page-script-messaging.html for the demo.",
"javascript_apis": [],
"name": "page-to-extension-messaging"
},
{
"description": "Demonstrates optional permissions using the permissions API.",
"javascript_apis": [
"browserAction.onClicked",
"permissions.getAll",
"permissions.remove",
"permissions.request",
"runtime.getURL",
"tabs.create"
],
"name": "permissions"
},
{
"description": "Example dynamic theme: sets a dark theme for private windows.",
"javascript_apis": [
"theme.reset",
"theme.update",
"windows.getAll",
"windows.onCreated"
],
"name": "private-browsing-theme"
},
{
"description": "Uses the proxy API to block requests to specific hosts.",
"javascript_apis": [
"extension.getURL",
"proxy.onProxyError",
"proxy.register",
"runtime.onMessage",
"runtime.sendMessage",
"storage.local",
"storage.onChanged"
],
"name": "proxy-blocker"
},
{
"description": "Allows the user to make quick notes by clicking a button and entering text into the resulting popup. The notes are saved in storage.",
"javascript_apis": [
"storage.local"
],
"name": "quicknote"
},
{
"description": "Demo of various runtime APIs.",
"javascript_apis": [
"browserAction.onClicked",
"notifications.create",
"runtime.getManifest",
"runtime.onInstalled",
"runtime.reload"
],
"name": "runtime-examples"
},
{
"description": "Demonstrates how to write to the clipboard from a content script",
"javascript_apis": [],
"name": "selection-to-clipboard"
},
{
"description": "Demonstrates how to retrieve extension-defined state state from restored tabs.",
"javascript_apis": [
"menus.create",
"menus.onClicked",
"sessions.getTabValue",
"sessions.setTabValue",
"tabs.insertCSS",
"tabs.onCreated",
"tabs.onUpdated",
"tabs.query"
],
"name": "session-state"
},
{
"description": "Demonstrates how to use the idb-file-storage library to store and manipulate files in an extension.",
"javascript_apis": [
"browserAction.onClicked",
"contextMenus.create",
"contextMenus.onClicked",
"runtime.onMessage",
"runtime.sendMessage",
"tabs.create",
"windows.create"
],
"name": "store-collected-images"
},
{
"description": "Performs basic authentication by supplying stored credentials.",
"javascript_apis": [
"storage.local",
"webRequest.onAuthRequired",
"webRequest.onCompleted",
"webRequest.onErrorOccurred"
],
"name": "stored-credentials"
},
{
"description": "Demonstrates tab manipulation: opening, closing, moving, zooming tabs.",
"javascript_apis": [
"browserAction.setBadgeBackgroundColor",
"browserAction.setBadgeText",
"tabs.create",
"tabs.duplicate",
"tabs.getZoom",
"tabs.move",
"tabs.onCreated",
"tabs.onMoved",
"tabs.onRemoved",
"tabs.query",
"tabs.reload",
"tabs.remove",
"tabs.setZoom",
"tabs.update"
],
"name": "tabs-tabs-tabs"
},
{
"description": "A sidebar that integrates with the current theme.",
"javascript_apis": [
"theme.getCurrent",
"theme.onUpdated",
"windows.getCurrent"
],
"name": "theme-integrated-sidebar"
},
{
"description": "An example of how to use the management API for themes.",
"javascript_apis": [
"management.getAll",
"management.setEnabled"
],
"name": "theme-switcher"
},
{
"description": "A collection of themes illustrating:<ul><li>weta_fade: a basic theme employing a single image specified in <code>headerURL:</code>.</li><li>weta_fade_chrome: the weta_fade theme implemented with Chrome compatible manifest keys.</li><li>weta_tiled: a theme using a tiled image.</li><li>weta_mirror: a theme using multiple images and aligning those images in the header.</li><li>animated: use of an animated PNG.</li></ul>",
"javascript_apis": [],
"name": "themes"
},
{
"description": "Demonstration of the topSites API.",
"javascript_apis": [
"topSites.get"
],
"name": "top-sites"
},
{
"description": "Demonstrates using the webRequest API to rewrite the User-Agent HTTP header.",
"javascript_apis": [
"extension.getBackgroundPage",
"webRequest.onBeforeSendHeaders"
],
"name": "user-agent-rewriter"
},
{
"description": "",
"javascript_apis": [
"contentScripts.register",
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "user-script"
},
{
"description": "Demonstrates how to use webpack to package npm modules in an extension.",
"javascript_apis": [
"runtime.onMessage",
"runtime.sendMessage"
],
"name": "webpack-modules"
},
{
"description": "Demonstrates how to manipulate windows: opening, closing, resizing windows.",
"javascript_apis": [
"windows.create",
"windows.getAll",
"windows.getCurrent",
"windows.remove",
"windows.update"
],
"name": "window-manipulator"
}
]