Skip to content

Main Navigation Guide Examples API Blog

wxt

Other Packages

@wxt-dev/analytics — 0.5.6

@wxt-dev/auto-icons — 1.1.2

@wxt-dev/i18n — 0.2.7

@wxt-dev/storage — 1.2.9

@wxt-dev/unocss — 1.0.1

@wxt-dev/runner — 0.1.2

@wxt-dev/is-background — 1.0.1

Appearance

Sidebar Navigation

CLI Reference

wxt

wxt build

wxt zip

wxt prepare

wxt clean

wxt init

wxt submit

wxt submit init

API Reference

wxt

Interfaces 54

BackgroundDefinition

BackgroundEntrypoint

BackgroundEntrypointOptions

BaseContentScriptEntrypointOptions

BaseEntrypoint

BaseEntrypointOptions

BaseScriptEntrypointOptions

BuildOutput

BuildStepOutput

ConfigEnv

ContentScriptEntrypoint

CopiedPublicFile

Dependency

EntrypointInfo

Eslintrc

ExtensionRunner

FirefoxDataCollectionPermissions

FsCache

GeneratedPublicFile

GenericEntrypoint

InlineConfig

IsolatedWorldContentScriptDefinition

IsolatedWorldContentScriptEntrypointOptions

Logger

MainWorldContentScriptDefinition

MainWorldContentScriptEntrypointOptions

OptionsEntrypoint

OptionsEntrypointOptions

OutputAsset

OutputChunk

PopupEntrypoint

PopupEntrypointOptions

ReloadContentScriptPayload

ResolvedBasePublicFile

ResolvedConfig

ResolvedEslintrc

ServerInfo

SidepanelEntrypoint

SidepanelEntrypointOptions

ThemeIcon

UnlistedScriptDefinition

UnlistedScriptEntrypoint

WebExtConfig

Wxt

WxtBuilder

WxtBuilderServer

WxtDevServer

WxtDirFileEntry

WxtDirTypeReferenceEntry

WxtHooks

WxtLogger

WxtModule

WxtModuleWithMetadata

WxtPackageManager

Type Aliases 28

ContentScriptDefinition

Entrypoint

EntrypointGroup

EslintConfigVersion

EslintGlobalsPropValue

FirefoxDataCollectionType

HookResult

OnContentScriptStopped

OutputFile

PerBrowserMap

PerBrowserOption

PrepareTsconfigs

PublicPathEntry

ResolvedPerBrowserOptions

ResolvedPublicFile

TargetBrowser

TargetManifestVersion

UserConfig

UserManifest

UserManifestFn

WxtCommand

WxtDirEntry

WxtModuleOptions

WxtModuleSetup

WxtPlugin

WxtResolvedUnimportOptions

WxtUnimportOptions

WxtViteConfig

Variables 1

version

Functions 10

build

clean

createServer

defineConfig

defineWebExtConfig

getEntrypointBundlePath

initialize

normalizePath

prepare

zip

wxt/modules

Functions 7

addAlias

addEntrypoint

addImportPreset

addPublicAssets

addViteConfig

addWxtPlugin

defineWxtModule

wxt/testing/fake-browser

Type Aliases 1

FakeBrowser

Variables 1

fakeBrowser

wxt/testing/vitest-plugin

Functions 1

WxtVitest

wxt/utils/app-config

Functions 2

getAppConfig

useAppConfig

wxt/utils/content-script-context

Classes 1

ContentScriptContext

Interfaces 1

WxtWindowEventMap

wxt/utils/content-script-ui/iframe

Interfaces 1

IframeContentScriptUi

Type Aliases 1

IframeContentScriptUiOptions

Functions 1

createIframeUi

wxt/utils/content-script-ui/integrated

Interfaces 1

IntegratedContentScriptUi

Type Aliases 1

IntegratedContentScriptUiOptions

Functions 1

createIntegratedUi

wxt/utils/content-script-ui/shadow-root

Interfaces 1

ShadowRootContentScriptUi

Type Aliases 1

ShadowRootContentScriptUiOptions

Functions 1

createShadowRootUi

wxt/utils/content-script-ui/types

Interfaces 8

AutoMount

BaseMountFunctions

ContentScriptAnchoredOptions

ContentScriptInlinePositioningOptions

ContentScriptModalPositioningOptions

ContentScriptOverlayPositioningOptions

ContentScriptUi

MountFunctions

Type Aliases 6

AutoMountOptions

ContentScriptAppendMode

ContentScriptOverlayAlignment

ContentScriptPositioningOptions

ContentScriptUiOptions

StopAutoMount

wxt/utils/define-app-config

Interfaces 1

WxtAppConfig

Functions 1

defineAppConfig

wxt/utils/define-background

Functions 1

defineBackground

wxt/utils/define-content-script

Functions 1

defineContentScript

wxt/utils/define-unlisted-script

Functions 1

defineUnlistedScript

wxt/utils/define-wxt-plugin

Functions 1

defineWxtPlugin

wxt/utils/inject-script

Interfaces 2

InjectScriptOptions

InjectScriptResult

Type Aliases 1

ScriptPublicPath

Functions 1

injectScript

wxt/utils/match-patterns

Classes 2

InvalidMatchPattern

MatchPattern

wxt/utils/split-shadow-root-css

Functions 1

splitShadowRootCss

wxt/utils/storage

Classes 1

MigrationError

Interfaces 6

GetItemOptions

RemoveItemOptions

SnapshotOptions

WxtStorage

WxtStorageItem

WxtStorageItemOptions

Type Aliases 5

StorageArea

StorageAreaChanges

StorageItemKey

Unwatch

WatchCallback

Variables 1

storage

On this page

Are you an LLM? You can read better optimized documentation at /api/reference/wxt/utils/define-background.md for this page in Markdown format

API / wxt/utils/define-background

Module: wxt/utils/define-background

Functions

defineBackground

Generated using typedoc-plugin-markdown and TypeDoc

Pager

Previous pagedefineAppConfig

Next pagedefineBackground

Released under the MIT License.

Copyright © 2023-present Aaron Klinker