contentScripts.RegisteredContentScript
A RegisteredContentScript
is returned by a call to contentScripts.register()
and represents the content scripts registered in that call.
It defines a single function unregister()
, which can be used to unregister the content scripts.
Note: If this object is destroyed (for example because it goes out of scope) then the content scripts will be unregistered automatically, so you should keep a reference to this object for as long as you want the content scripts to stay registered.
Methods
-
unregister()
-
Unregisters the content scripts represented by this object.
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
RegisteredContentScript |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
No |
? |
unregister |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
No |
? |
Examples
This code toggles a registered content script on a browser action click:
let registered = null;
async function register() {
registered = await browser.contentScripts.register({
matches: ["*://*.org/*"],
js: [{
code: "document.body.innerHTML = '<h1>This page has been eaten<h1>'"
}],
runAt: "document_idle"
});
}
function toggle() {
if (registered) {
registered.unregister();
registered = null;
} else {
register();
}
}
browser.browserAction.onClicked.addListener(toggle);