content_scripts
Type | Array |
---|---|
Mandatory | No |
Manifest version | 2 or higher |
Example |
json
|
Instructs the browser to load content scripts into web pages whose URL matches a given pattern.
This key is an array. Each item is an object which:
- must contain a key named
matches
, which specifies the URL patterns to be matched in order for the scripts to be loaded; - may contain keys named
js
andcss
, which list scripts and/or stylesheets to be loaded into matching pages; and - may contain a number of other properties that control finer aspects of how and when content scripts are loaded.
Details of all the keys you can include are given in the table below.
Name | Type | Description |
---|---|---|
all_frames |
Boolean |
Defaults to |
css |
Array |
An array of paths, relative to
Files are injected in the order given, and at the time specified by
Note: Firefox resolves URLs in injected CSS files relative to the CSS file itself, rather than to the page it's injected into. |
exclude_globs |
Array |
An array of strings containing wildcards. See Matching URL patterns below. |
exclude_matches |
Array |
An array of match patterns. See Matching URL patterns below. |
include_globs |
Array |
An array of strings containing wildcards. See Matching URL patterns below. |
js |
Array |
An array of paths, relative to Files are injected in the order given. This means that, for example, if you include jQuery here followed by another content script, like this: json
Then,
The files are injected after any files in
|
match_about_blank |
Boolean |
Insert the content scripts into pages whose URL is
This is especially useful to run scripts in empty iframes, whose URL
is
For example, suppose you have a json
If the user loads
Note:
Note that in Firefox, content scripts won't be injected into empty
iframes at |
matches |
Array |
An array of match patterns. See Matching URL patterns below. This is the only mandatory key. |
run_at |
String |
This option determines when the files specified in
The default value is |
Matching URL patterns
The "content_scripts"
key attaches content scripts to documents based on URL matching: if the document's URL matches the specification in the key, then the script will be attached. There are four properties inside "content_scripts"
that you can use for this specification:
matches
-
an array of match patterns
exclude_matches
-
an array of match patterns
include_globs
-
an array of globs
exclude_globs
-
an array of globs
To match one of these properties, a URL must match at least one of the items in its array. For example, given a property like:
json
"matches": ["*://*.example.org/*", "*://*.example.com/*"]
Both http://example.org/
and http://example.com/
will match.
Since matches
is the only mandatory key, the other three keys are used to limit further the URLs that match. To match the key as a whole, a URL must:
- match the
matches
property - AND match the
include_globs
property, if present - AND NOT match the
exclude_matches
property, if present - AND NOT match the
exclude_globs
property, if present
globs
A glob is just a string that may contain wildcards.
There are two types of wildcard, and you can combine them in the same glob:
*
matches zero or more characters?
matches exactly one character.
For example: "*na?i"
would match "illuminati"
and "annunaki"
, but not "sagnarelli"
.
Example
json
"content_scripts": [
{
"matches": ["*://*.mozilla.org/*"],
"js": ["borderify.js"]
}
]
This injects a single content script borderify.js
into all pages under mozilla.org
or any of its subdomains, whether served over HTTP or HTTPS.
json
"content_scripts": [
{
"exclude_matches": ["*://developer.mozilla.org/*"],
"matches": ["*://*.mozilla.org/*"],
"js": ["jquery.js", "borderify.js"]
}
]
This injects two content scripts into all pages under mozilla.org
or any of its subdomains except developer.mozilla.org
, whether served over HTTP or HTTPS.
The content scripts see the same view of the DOM and are injected in the order they appear in the array, so borderify.js
can see global variables added by jquery.js
.
Browser compatibility
BCD tables only load in the browser