Skip to content
Branch: master
Find file History

README.md

User script

This extension demonstrates the browser.contentScripts.register() API, which enables an extension to register URL-matching content scripts at runtime.

This extension adds a browser action that shows a popup. The popup lets you specify:

  • some code that comprises your content script
  • one or more match patterns, comma-separated. The content script will only be loaded into pages whose URLs match these patterns.

Once these are set up you can register the content script by clicking "Register script". The extension will then register a content script with the given properties by calling browser.contentScripts.register().

To keep things simple, you can only have one script registered at any time: if you click "Register script" again, the old script is unregistered. To do this, the extension keeps a reference to the RegisteredContentScript object returned from browser.contentScripts.register(): this object provides the unregister() method.

Note that the extension uses a background script to register the content scripts and to keep a reference to the RegisteredContentScript object. If it did not do this, then as soon as the popup window closed, the RegisteredContentScript would go out of scope and be destroyed, and the browser would then unregister the content script as part of cleanup.

Default settings

The popup is initialized with some default values for the pattern and the code:

  • the pattern *://*.org/*, which will load the script into any HTTP or HTTPS pages on a .org domain.
  • the code document.body.innerHTML = '<h1>This page has been eaten<h1>'

To try the extension out quickly, just click "Register script" with these defaults, and load http://example.org/ or https://www.mozilla.org/. Then try changing the pattern or the code, and reloading these or related pages.

You can’t perform that action at this time.