WXT

Appearance

API > wxt > MainWorldContentScriptDefinition

Interface: MainWorldContentScriptDefinition ​

Contents ​

Extends ​

Properties ​

allFrames ​

allFrames?: PerBrowserOption<undefined | boolean>

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

Default ​

ts
false

Inherited from ​

MainWorldContentScriptEntrypointOptions.allFrames

Source ​

packages/wxt/src/types.ts:623

cssInjectionMode ​

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

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 ​

MainWorldContentScriptEntrypointOptions.cssInjectionMode

Source ​

packages/wxt/src/types.ts:642

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 ​

MainWorldContentScriptEntrypointOptions.exclude

Source ​

packages/wxt/src/types.ts:573

excludeGlobs ​

excludeGlobs?: PerBrowserOption<undefined | string[]>

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

Default ​

ts
[]

Inherited from ​

MainWorldContentScriptEntrypointOptions.excludeGlobs

Source ​

packages/wxt/src/types.ts:618

excludeMatches ​

excludeMatches?: PerBrowserOption<undefined | string[]>

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

Default ​

ts
[]

Inherited from ​

MainWorldContentScriptEntrypointOptions.excludeMatches

Source ​

packages/wxt/src/types.ts:608

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 ​

MainWorldContentScriptEntrypointOptions.include

Source ​

packages/wxt/src/types.ts:566

includeGlobs ​

includeGlobs?: PerBrowserOption<undefined | string[]>

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

Default ​

ts
[]

Inherited from ​

MainWorldContentScriptEntrypointOptions.includeGlobs

Source ​

packages/wxt/src/types.ts:613

matchAboutBlank ​

matchAboutBlank?: PerBrowserOption<undefined | boolean>

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

Default ​

ts
false

Inherited from ​

MainWorldContentScriptEntrypointOptions.matchAboutBlank

Source ​

packages/wxt/src/types.ts:601

matchOriginAsFallback ​

matchOriginAsFallback?: PerBrowserOption<boolean>

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

Default ​

ts
false

Inherited from ​

MainWorldContentScriptEntrypointOptions.matchOriginAsFallback

Source ​

packages/wxt/src/types.ts:628

matches ​

matches: PerBrowserOption<string[]>

Inherited from ​

MainWorldContentScriptEntrypointOptions.matches

Source ​

packages/wxt/src/types.ts:591

registration ​

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

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/execute the content script dynamically at runtime.

Default ​

ts
"manifest"

Inherited from ​

MainWorldContentScriptEntrypointOptions.registration

Source ​

packages/wxt/src/types.ts:654

runAt ​

runAt?: PerBrowserOption<undefined | RunAt>

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

Default ​

ts
"documentIdle"

Inherited from ​

MainWorldContentScriptEntrypointOptions.runAt

Source ​

packages/wxt/src/types.ts:596

world ​

world: "MAIN"

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

Inherited from ​

MainWorldContentScriptEntrypointOptions.world

Source ​

packages/wxt/src/types.ts:662

Methods ​

main() ​

main(): any

Main function executed when the content script is loaded.

When running a content script with browser.scripting.executeScript, values returned from this function will be returned in the executeScript result as well. Otherwise returning a value does nothing.

Source ​

packages/wxt/src/types.ts:809

Generated using typedoc-plugin-markdown and TypeDoc