Warning: This is documentation for the legacy userScripts
API. It's available in Firefox for Manifest V2. For functionality to work with user scripts in Manifest V3 see the new userScripts
API.
Use this API to register user scripts, third-party scripts designed to manipulate webpages or provide new features. Registering a user script instructs the browser to attach the script to pages that match the URL patterns specified during registration.
This API offers similar capabilities to contentScripts
but with features suited to handling third-party scripts:
window
and document
global values related to the webpage the user script is attached to.Warning: This API requires the presence of the user_scripts
key in the manifest.json, even if no API script is specified. For example. user_scripts: {}
.
To use the API, call register()
passing in an object defining the scripts to register. The method returns a Promise that is resolved with a RegisteredUserScript
object.
Note: User scripts are unregistered when the related extension page (from which the user scripts were registered) is unloaded, so you should register a user script from an extension page that persists at least as long as you want the user scripts to stay registered.
TypesuserScripts.RegisteredUserScript
The object
returned by the register()
method. It represents the registered user scripts and is used to deregister the user scripts.
userScripts.UserScriptOptions
The object
passed to the register()
method. It represents the content scripts to register.
userScripts.register()
Registers user scripts.
userScripts.onBeforeScript
An event available to the API script, registered in "user_scripts"
, that execute before a user script executes. Use it to trigger the export of the additional APIs provided by the API script, so they are available to the user script.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4