oleks/wxt

Files

T

Aaron 927aca612e fix!: Move browser constants to import.meta.env (#380 )

BREAKING CHANGE: Renamed undocumented constants:

- `__BROWSER__` &rarr; `import.meta.env.BROWSER`
- `__COMMAND__` &rarr; `import.meta.env.COMMAND`
- `__MANIFEST_VERSION__` &rarr; `import.meta.env.MANIFEST_VERSION`
- `__IS_CHROME__` &rarr; `import.meta.env.CHROME`
- `__IS_FIREFOX__` &rarr; `import.meta.env.FIREFOX`
- `__IS_SAFARI__` &rarr; `import.meta.env.SAFARI`
- `__IS_EDGE__` &rarr; `import.meta.env.EDGE`
- `__IS_OPERA__` &rarr; `import.meta.env.OPERA`

2024-01-29 11:14:18 -06:00

4.3 KiB

Raw Blame History

Multiple Browsers

You can build an extension for any combination of browser and manifest verison. Different browsers and manifest versions support different APIs and entrypoints, so be sure to check that your extension functions as expected for each target.

Separate build targets are written to their own output directories:

<rootDir>
└─ .output
   ├─ chrome-mv3
   ├─ firefox-mv2
   ├─ edge-mv3
   └─ ...

Target Browser

To build for a specific browser, pass the -b --browser flag from the CLI:

wxt --browser firefox
wxt build --browser firefox

By default, it will build for chrome. When excluding the manifest version flags, it will default to the commonly accepted manifest version for that browser.

Browser	Default Manifest Version
`chrome`	3
`firefox`	2
`safari`	2
`edge`	3
Any other string	3

:::tip To configure which browser is opened when running dev mode via wxt -b <browser>, see the Development docs docs. :::

Target Manifest Version

To build for a specific manifest version, pass either the --mv2 flag or --mv3 flag from the CLI.

wxt --mv2
wxt build --mv2

When the -b --browser flag is not passed, it defaults to chrome. So here, we're targetting MV2 for Chrome.

Customizing Entrypoints

There are several ways to customize entrypoint definitions per browser.

First, you can use either the include or exclude option to include or exclude the entrypoint from specific browsers. Here are some examples

:::code-group

export default defineBackground({
  // Only include a background script when targeting chrome
  include: ['chrome'],
});

export default defineContentScript({
  // Do not add this content script to the manifest when targeting firefox
  exclude: ['firefox'],
});

<!-- entrypoints/options.html -->
<html>
  <head>
    <!-- Don't include the options page for safari -->
    <meta name="manifest.exclude" content="['safari']" />
  </head>
</html>

:::

Second, you can change individual options per-browser:

:::code-group

export default defineBackground({
  persistent: {
    // Use a non-persistent background script for just safari
    safari: false,
  },
});

export default defineContentScript({
  matches: {
    // Run the content script on different pages for each browser
    chrome: ['*://*.google.com/*'],
    firefox: ['*://*.duckduckgo.com/*'],
    edge: ['*://*.bing.com/*'],
  },
});

:::

:::warning Only defineBackground and defineContentScript support per-browser options right now. :::

Runtime

To determine the browser or manifest version at runtime, you can use any of the below variables:

import.meta.env.BROWSER: A string, the target browser, usually equal to the --browser flag
import.meta.env.MANIFEST_VERSION: A number, either 2 or 3, depending on the manifest version targetted
import.meta.env.CHROME: A boolean equivalent to import.meta.env.BROWSER === "chrome"
import.meta.env.FIREFOX: A boolean equivalent to import.meta.env.BROWSER === "firefox"
import.meta.env.EDGE: A boolean equivalent to import.meta.env.BROWSER === "edge"
import.meta.env.SAFARI: A boolean equivalent to import.meta.env.BROWSER === "safari"
import.meta.env.OPERA: A boolean equivalent to import.meta.env.BROWSER === "opera"
import.meta.env.COMMAND: A string, "serve" when running wxt for development or "build" in all other cases.

:::info These variables are constants defined at build time based on the build target. They do not actually detect which browser the code is running in.

For example, if you build for --browser chrome and publish it on Edge, import.meta.env.BROWSER will be "chrome", not "edge". You have to build a separate ZIP for --browser edge before import.meta.env.BROWSER will be "edge".

If you need to know the actual browser your code is being ran on, you should use a user agent parser. :::

4.3 KiB Raw Blame History