Skip to content

API > wxt > IsolatedWorldContentScriptDefinition

Interface: IsolatedWorldContentScriptDefinition

Contents

Extends

Properties

allFrames

allFrames?: PerBrowserOption<undefined | boolean>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
false

Inherited from

IsolatedWorldContentScriptEntrypointOptions.allFrames

Source

src/types/index.ts:571


cssInjectionMode

cssInjectionMode?: PerBrowserOption<"ui" | "manifest" | "manual">

Customize how imported/generated styles are injected with the content script. Regardless of the mode selected, CSS will always be built and included in the output directory.

  • "manifest" - Include the CSS in the manifest, under the content script's css array.
  • "manual" - Exclude the CSS from the manifest. You are responsible for manually loading it onto the page. Use browser.runtime.getURL("content-scripts/<name>.css") to get the file's URL
  • "ui" - Exclude the CSS from the manifest. CSS will be automatically added to your UI when calling createShadowRootUi

Default

ts
"manifest"

Inherited from

IsolatedWorldContentScriptEntrypointOptions.cssInjectionMode

Source

src/types/index.ts:590


exclude

exclude?: string[]

List of target browsers to exclude this entrypoint from. Cannot be used with include. You must choose one of the two options.

Default

ts
undefined

Inherited from

IsolatedWorldContentScriptEntrypointOptions.exclude

Source

src/types/index.ts:521


excludeGlobs

excludeGlobs?: PerBrowserOption<undefined | string[]>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
[]

Inherited from

IsolatedWorldContentScriptEntrypointOptions.excludeGlobs

Source

src/types/index.ts:566


excludeMatches

excludeMatches?: PerBrowserOption<undefined | string[]>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
[]

Inherited from

IsolatedWorldContentScriptEntrypointOptions.excludeMatches

Source

src/types/index.ts:556


include

include?: string[]

List of target browsers to include this entrypoint in. Defaults to being included in all builds. Cannot be used with exclude. You must choose one of the two options.

Default

ts
undefined

Inherited from

IsolatedWorldContentScriptEntrypointOptions.include

Source

src/types/index.ts:514


includeGlobs

includeGlobs?: PerBrowserOption<undefined | string[]>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
[]

Inherited from

IsolatedWorldContentScriptEntrypointOptions.includeGlobs

Source

src/types/index.ts:561


matchAboutBlank

matchAboutBlank?: PerBrowserOption<undefined | boolean>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
false

Inherited from

IsolatedWorldContentScriptEntrypointOptions.matchAboutBlank

Source

src/types/index.ts:549


matchOriginAsFallback

matchOriginAsFallback?: PerBrowserOption<boolean>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
false

Inherited from

IsolatedWorldContentScriptEntrypointOptions.matchOriginAsFallback

Source

src/types/index.ts:576


matches

matches: PerBrowserOption<string[]>

Inherited from

IsolatedWorldContentScriptEntrypointOptions.matches

Source

src/types/index.ts:539


registration

registration?: PerBrowserOption<"manifest" | "runtime">

Specify how the content script is registered.

  • "manifest": The content script will be added to the content_scripts entry in the manifest. This is the normal and most well known way of registering a content script.
  • "runtime": The content script's matches is added to host_permissions and you are responsible for using the scripting API to register the content script dynamically at runtime.

Default

ts
"manifest"

Inherited from

IsolatedWorldContentScriptEntrypointOptions.registration

Source

src/types/index.ts:602


runAt

runAt?: PerBrowserOption<undefined | RunAt>

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default

ts
"documentIdle"

Inherited from

IsolatedWorldContentScriptEntrypointOptions.runAt

Source

src/types/index.ts:544


world

world?: "ISOLATED"

See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world

Default

ts
"ISOLATED"

Inherited from

IsolatedWorldContentScriptEntrypointOptions.world

Source

src/types/index.ts:619

Methods

main()

main(ctx): void | Promise<void>

Main function executed when the content script is loaded.

Parameters

ctx: ContentScriptContext

Source

src/types/index.ts:741


Generated using typedoc-plugin-markdown and TypeDoc