Skip to content

API > wxt > PopupEntrypointOptions

Interface: PopupEntrypointOptions

Contents

Extends

Properties

actionType

actionType?: PerBrowserOption<"browser_action" | "page_action">

The type of action to use in the manifest.

In MV2, defaults to "browser_action". In MV3, "browser_action" is converted to "action", while "page_action" is kept as-is (Firefox MV3 only).

Source

packages/wxt/src/types.ts:800


browserStyle

browserStyle?: PerBrowserOption<boolean>

Source

packages/wxt/src/types.ts:811


defaultArea

defaultArea?: PerBrowserOption<"navbar" | "menupanel" | "tabstrip" | "personaltoolbar">

Firefox only. Defines the part of the browser in which the button is initially placed.

See

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/action#default_area

Source

packages/wxt/src/types.ts:818


defaultIcon

defaultIcon?: Record<string, string>

Source

packages/wxt/src/types.ts:803


defaultState

defaultState?: PerBrowserOption<"enabled" | "disabled">

Chrome only. Controls the initial enabled/disabled state of the action.

See

https://developer.chrome.com/docs/extensions/reference/api/action#enabled_state

Source

packages/wxt/src/types.ts:810


defaultTitle

defaultTitle?: PerBrowserOption<string>

Source

packages/wxt/src/types.ts:804


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

BaseEntrypointOptions.exclude

Source

packages/wxt/src/types.ts:614


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

BaseEntrypointOptions.include

Source

packages/wxt/src/types.ts:607


mv2Key

mv2Key?: PerBrowserOption<"browser_action" | "page_action">

Deprecated

Use actionType instead.

Source

packages/wxt/src/types.ts:802


ref

ref?: string

Stable identifier for this entrypoint, independent of its filename. Modules like @wxt-dev/entrypoint-refs can use it to emit constant names that do not change when the source file is renamed. Defaults to the entrypoint name.

Default

ts
undefined

Inherited from

BaseEntrypointOptions.ref

Source

packages/wxt/src/types.ts:623


themeIcons

themeIcons?: ThemeIcon[]

Firefox only. Icons for light and dark themes.

See

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/action#theme_icons

Source

packages/wxt/src/types.ts:826


Generated using typedoc-plugin-markdown and TypeDoc