https://github.com/firefox-devtools/extension-examples

DevTools extension examples
https://github.com/firefox-devtools/extension-examples

Last synced: 3 months ago
JSON representation

DevTools extension examples

• Host: GitHub
• URL: https://github.com/firefox-devtools/extension-examples
• Owner: firefox-devtools
• License: mpl-2.0
• Created: 2017-02-22T13:12:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-28T20:05:54.000Z (over 5 years ago)
• Last Synced: 2024-03-26T09:01:23.710Z (3 months ago)
• Language: JavaScript
• Size: 335 KB
• Stars: 24
• Watchers: 7
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-webextension - Firefox Toolbox Extensions Examples

README

        
# DevTools Extension Examples

This repository is a collection of DevTools extension examples, demonstrating how to build add-ons for Firefox DevTools using the [WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) APIs.

## Getting started

To install and run any of the add-ons in this repository, follow the instructions for [temporary installation in Firefox](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox).

This is *the developer way* of doing it, and is not the way users of your add-ons will use.

If you're new to the WebExtensions + DevTools world, we recommend you look at the add-ons in the following order. Each directory contains a README file with more information related to that add-on.

### [devtools-panel](./devtools-panel)

Shows how to create a new panel in DevTools.

### [console](./console)

Demonstrates how to evaluate scripts in the inspected window (i.e. the `content` scope).

### [messaging](./messaging)

*(Work in progress)*

Demonstrates how to communicate among different scopes.

## More resources

* The [webextensions-examples](https://github.com/mdn/webextensions-examples) repository has *a lot* of examples demonstrating how to build WebExtensions, and also **great documentation**.

* Look at [bug 1211859 - Implement devtools API for open extension API](https://bugzilla.mozilla.org/show_bug.cgi?id=1211859) to track progress on Firefox implementation.

* [WebExtension Experiments](https://github.com/web-ext-experiments) is a repository with more *adventurous* examples.

* [Media Panel](https://github.com/karolien/media-devtools-panel): a WebExtension to add a *Media* panel to DevTools.