chore(release): wxt v0.19.24

Co-authored-by: Aaron <aaronklinker1@gmail.com>

docs/.vitepress/components/UsingWxtSection.vue

@@ -61,6 +61,9 @@ const chromeExtensionIds = [
   'eihpmapodnppeemkhkbhikmggfojdkjd', // Cursorful - Screen Recorder with Auto Zoom
   'hjjkgbibknbahijglkffklflidncplkn', // Show IP – Live View of Website IPs for Developers
   'ilbikcehnpkmldojkcmlldkoelofnbde', // Strong Password Generator
+  'ocllfkhcdopiafndigclebelbecaiocp', // ZenGram: Mindful Instagram, Your Way
+  'odffpjnpocjfcaclnenaaaddghkgijdb', // Blync: Preview Links, Selection Search, AI Assistant
+  'kofbbilhmnkcmibjbioafflgmpkbnmme', // HTML to Markdown - Convert webpages to markdown
 ];
 
 const { data, err, isLoading } = useListExtensionDetails(chromeExtensionIds);

docs/guide/essentials/config/browser-startup.md

@@ -41,6 +41,8 @@ export default defineRunnerConfig({
 });
 ```
 
+By default, WXT will try to automatically discover where Chrome/Firefox are installed. However, if you have chrome installed in a non-standard location, you need to set it manually as shown above.
+
 ### Persist Data
 
 By default, to keep from modifying your browser's existing profiles, `web-ext` creates a brand new profile every time you run the `dev` script.

docs/guide/essentials/config/manifest.md

@@ -1,10 +1,17 @@
 # Manifest
 
-In WXT, there is no `manifest.json` file in your source code. Instead, WXT generates it during the build process based off files in your project.
+In WXT, there is no `manifest.json` file in your source code. Instead, WXT generates the manifest from multiple sources:
 
-## Manifest Config
+- Global options [defined in your `wxt.config.ts` file](#global-options)
+- Entrypoint-specific options [defined in your entrypoints](/guide/essentials/entrypoints#defining-manifest-options)
+- [WXT Modules](/guide/essentials/wxt-modules) added to your project can modify your manifest
+- [Hooks](/guide/essentials/config/hooks) defined in your project can modify your manifest
 
-To manually add a property to the `manifest.json` output during builds, use the `manifest` config inside `wxt.config.ts`:
+Your extension's `manifest.json` will be output to `.output/{target}/manifest.json` when running `wxt build`.
+
+## Global Options
+
+To add a property to your manifest, use the `manifest` config inside your `wxt.config.ts`:
 
 ```ts
 export default defineConfig({
@@ -130,7 +137,7 @@ public/
 └─ icon-128.png
 ```
 
-Specifically, if an icon must match one of these regex to be discovered:
+Specifically, an icon must match one of these regex to be discovered:
 
 <<< @/../packages/wxt/src/core/utils/manifest.ts#snippet
 
@@ -216,22 +223,7 @@ By default, whenever an `action` is generated, WXT falls back to `browser_action
 
 ### Action With Popup
 
-To generate a manifest where a UI appears after clicking the icon, just create a [Popup entrypoint](/guide/essentials/entrypoints#popup).
-
-```ts
-export default defineConfig({
-  hooks: {
-    build: {
-      manifestGenerated(manifest) {
-        // Update the manifest variable by reference
-        manifest.name = 'Overriden name';
-      },
-    },
-  },
-});
-```
-
-If you want to use a `page_action` for MV2, add the following meta tag to the HTML document's head:
+To generate a manifest where a UI appears after clicking the icon, just create a [Popup entrypoint](/guide/essentials/entrypoints#popup). If you want to use a `page_action` for MV2, add the following meta tag to the HTML document's head:
 
 ```html
 <meta name="manifest.type" content="page_action" />

docs/guide/essentials/content-scripts.md

@@ -4,12 +4,14 @@ outline: deep
 
 # Content Scripts
 
+> To create a content script, see [Entrypoint Types](/guide/essentials/entrypoints#content-scripts).
+
 ## Context
 
 The first argument to a content script's `main` function is it's "context".
 
 ```ts
-// entrypoints/content.ts
+// entrypoints/example.content.ts
 export default defineContentScript({
   main(ctx) {},
 });
@@ -62,7 +64,7 @@ In regular web extensions, CSS for content scripts is usually a separate CSS fil
 In WXT, to add CSS to a content script, simply import the CSS file into your JS entrypoint, and WXT will automatically add the bundled CSS output to the `css` array.
 
 ```ts
-// entrypoints/content/index.ts
+// entrypoints/example.content/index.ts
 import './style.css';
 
 export default defineContentScript({
@@ -198,6 +200,7 @@ export default defineContentScript({
 ```ts [Svelte]
 // entrypoints/example-ui.content/index.ts
 import App from './App.svelte';
+import { mount, unmount } from 'svelte';
 
 export default defineContentScript({
   matches: ['<all_urls>'],
@@ -208,14 +211,13 @@ export default defineContentScript({
       anchor: 'body',
       onMount: (container) => {
         // Create the Svelte app inside the UI container
-        const app = new App({
+        mount(App, {
           target: container,
         });
-        return app;
       },
       onRemove: (app) => {
         // Destroy the app when the UI is removed
-        app.$destroy();
+        unmount(app);
       },
     });
 
@@ -379,6 +381,7 @@ export default defineContentScript({
 // 1. Import the style
 import './style.css';
 import App from './App.svelte';
+import { mount, unmount } from 'svelte';
 
 export default defineContentScript({
   matches: ['<all_urls>'],
@@ -393,14 +396,13 @@ export default defineContentScript({
       anchor: 'body',
       onMount: (container) => {
         // Create the Svelte app inside the UI container
-        const app = new App({
+        mount(App, {
           target: container,
         });
-        return app;
       },
-      onRemove: (app) => {
+      onRemove: () => {
         // Destroy the app when the UI is removed
-        app?.$destroy();
+        unmount(app);
       },
     });
 
@@ -566,6 +568,20 @@ export default defineContentScript({
 });
 ```
 
+```json
+export default defineConfig({
+  manifest: {
+    // ...
+    web_accessible_resources: [
+      {
+        resources: ["example-main-world.js"],
+        matches: ["*://*/*"],
+      }
+    ]
+  }
+});
+```
+
 `injectScript` works by creating a `script` element on the page pointing to your script. This loads the script into the page's context so it runs in the main world.
 
 `injectScript` returns a promise, that when resolved, means the script has been evaluated by the browser and you can start communicating with it.

docs/guide/essentials/entrypoints.md

@@ -28,7 +28,7 @@ For web extensions, there are two types of entrypoints:
 - **Listed**: Referenced in the `manifest.json`
 - **Unlisted**: Not referenced in the `manifest.json`
 
-Throughout the rest of WXT's documentation, listed files are referred to by name. For example:
+Throughout the rest of WXT's documentation, listed entrypoints are referred to by name. For example:
 
 - Popup
 - Options
@@ -42,7 +42,7 @@ Some examples of "unlisted" entrypoints:
 - JS files injected by content scripts into the page's main world
 
 :::tip
-Regardless of whether a entrypoint is listed or unlisted, it will still be bundled into your extension and be available at runtime.
+Regardless of whether an entrypoint is listed or unlisted, it will still be bundled into your extension and be available at runtime.
 :::
 
 ## Adding Entrypoints
@@ -72,7 +72,7 @@ Refer to the [Entrypoint Types](#entrypoint-types) section for the full list of
 
 ## Defining Manifest Options
 
-Most listed entrypoints have options that need to be added to the `manifest.json`. With WXT however, instead of defining the options in a separate file, _you define these options inside the entrypoint file itself_.
+Most listed entrypoints have options that need to be added to the `manifest.json`. However with WXT, instead of defining the options in a separate file, _you define these options inside the entrypoint file itself_.
 
 For example, here's how to define `matches` for content scripts:
 
@@ -86,6 +86,17 @@ export default defineContentScript({
 });
 ```
 
+For HTML entrypoints, options are configured as `<meta>` tags. For example, to use a `page_action` for your MV2 popup:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta name="manifest.type" content="page_action" />
+  </head>
+</html>
+```
+
 > Refer to the [Entrypoint Types](#entrypoint-types) sections for a list of options configurable inside each entrypoint, and how to define them.
 
 When building your extension, WXT will look at the options defined in your entrypoints, and generate the manifest accordingly.

docs/guide/essentials/i18n.md

@@ -81,6 +81,10 @@ However, it is recommended you stick with the vanilla API (or a package based on
 - Translations are not bundled multiple times, keeping your extension small
 - Zero configuration
 
+However, there is one major downside to the vanilla API and any packages built on top of it:
+
+- Language cannot be changed without changing your browser/system language
+
 Here are some examples of how to setup a third party i18n library:
 
 - [vue-i18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vue-i18n)

docs/guide/essentials/project-structure.md

@@ -59,24 +59,24 @@ After enabling it, your project structure should look like this:
 <!-- prettier-ignore -->
 ```html
 📂 {rootDir}/
-📁 .output/
-📁 .wxt/
-📂 src/
-   📁 assets/
-   📁 components/
-   📁 composables/
-   📁 entrypoints/
-   📁 hooks/
-   📁 modules/
-   📁 public/
-   📁 utils/
-   📄 app.config.ts
-📄 .env
-📄 .env.publish
-📄 package.json
-📄 tsconfig.json
-📄 web-ext.config.ts
-📄 wxt.config.ts
+   📁 .output/
+   📁 .wxt/
+   📂 src/
+      📁 assets/
+      📁 components/
+      📁 composables/
+      📁 entrypoints/
+      📁 hooks/
+      📁 modules/
+      📁 public/
+      📁 utils/
+      📄 app.config.ts
+   📄 .env
+   📄 .env.publish
+   📄 package.json
+   📄 tsconfig.json
+   📄 web-ext.config.ts
+   📄 wxt.config.ts
 ```
 
 ## Customizing Other Directories

docs/guide/resources/faq.md

@@ -28,47 +28,137 @@ See https://wxt.dev/guide/essentials/config/browser-startup.html#persist-data
 
 ## My component library doesn't work in content scripts!
 
-Component libraries place their CSS in the document's `<head>` by default. When using `createShadowRootUi`, your UI is isolated from the document's styles because it's inside a ShadowRoot.
+This is usually caused by one of two things (or both) when using `createShadowRootUi`:
 
-To fix this, you need to tell your component library to insert it's CSS inside the shadow root. Here's the docs for a couple of popular libraries:
+1. Styles are added outside the `ShadowRoot`
 
-- React
-  - Ant Design: [`StyleProvider`](https://ant.design/docs/react/compatible-style#shadow-dom-usage)
-  - Mantine: [`MantineProvider#getRootElement` and `MantineProvider#cssVariablesSelector`](https://mantine.dev/theming/mantine-provider/)
+   :::details
+   Some component libraries manually add CSS to the page by adding a `<style>` or `<link>` element. They place this element in the document's `<head>` by default. This causes your styles to be placed outside the `ShadowRoot` and it's isolation blocks the styles from being applied to your UI.
 
-> If your library isn't listed above, try searching it's docs/issues for "shadow root", "shadow dom", or "css container".
+   When a library does this, **you need to tell the library where to put its styles**. Here's the documentation for a few popular component libraries:
 
-`createShadowRootUi` provides it's own `<head>` element inside the shadow root, so that were you should tell the library to add the CSS. Here's an example with Ant Design:
+   - Ant Design: [`StyleProvider`](https://ant.design/docs/react/compatible-style#shadow-dom-usage)
+   - Mantine: [`MantineProvider#getRootElement` and `MantineProvider#cssVariablesSelector`](https://mantine.dev/theming/mantine-provider/)
 
-```tsx
-import { StyleProvider } from '@ant-design/cssinjs'; // [!code ++]
-import ReactDOM from 'react-dom/client';
-import App from './App.tsx';
+   > If your library isn't listed above, try searching it's docs/issues for "shadow root", "shadow dom", or "css container". Not all libraries support shadow DOMs, you may have to open an issue to request this feature.
 
-const ui = await createShadowRootUi(ctx, {
-  name: 'example-ui',
-  position: 'inline',
-  anchor: 'body',
-  onMount: (container) => { // [!code --]
-  onMount: (container, shadow) => { // [!code ++]
-    const cssContainer = shadow.querySelector("head")!; // [!code ++]
-    const root = ReactDOM.createRoot(container);
-    root.render(
-      <StyleProvider container={cssContainer}> // [!code ++]
-        <App />
-      </StyleProvider> // [!code ++]
-    );
-    return root;
-  },
-  onRemove: (root) => {
-    root?.unmount();
-  },
-});
-```
+   Here's an example of configuring Antd's styles:
 
-Note that this doesn't effect all component libraries, just ones that inject CSS themselves rather than having you import their CSS. This approach is more prevailent in the React community, but not limited to it. That's why only React libraries are listed above. Vuetify, for example, works just fine because you import its CSS - WXT picks up on this and the CSS is added inside the shadow root automatically:
+   ```tsx
+   import { StyleProvider } from '@ant-design/cssinjs';
+   import ReactDOM from 'react-dom/client';
+   import App from './App.tsx';
 
-```ts
-import 'vuetify/styles'; // <-- This line imports the CSS, just like importing a .css file
-import { createVuetify } from 'vuetify';
-```
+   const ui = await create`ShadowRoot`Ui(ctx, {
+     // ...
+     onMount: (container, shadow) => {
+       const cssContainer = shadow.querySelector('head')!;
+       const root = ReactDOM.createRoot(container);
+       root.render(
+         <StyleProvider container={cssContainer}>
+           <App />
+         </StyleProvider>,
+       );
+       return root;
+     },
+   });
+   ```
+
+   :::
+
+2. UI elements are added outside the `ShadowRoot`
+
+   ::::::details
+   This is mostly caused by `Teleport` or `Portal` components that render an element somewhere else in the DOM, usually in the document's `<body>`. This is usually done for dialogs or popover components. This renders the element is outside the `ShadowRoot`, so styles are not applied to it.
+
+   To fix this, **you need to both provide a target to your app AND pass the target to the `Teleport`/`Portal`**.
+
+   First, store the reference to the `ShadowRoot`'s `<body>` element (not the document's `<body>`):
+
+   :::code-group
+
+   ```ts [Vue]
+   import { createApp } from 'vue';
+   import App from './App.vue';
+
+   const ui = await create`ShadowRoot`Ui(ctx, {
+     // ...
+     onMount: (container, shadow) => {
+       const teleportTarget = shadow.querySelector('body')!;
+       const app = createApp(App)
+         .provide('TeleportTarget', teleportTarget)
+         .mount(container);
+       return app;
+     },
+   });
+   ui.mount();
+   ```
+
+   ```tsx [React]
+   // hooks/PortalTargetContext.ts
+   import { createContext } from 'react';
+
+   export const PortalTargetContext = createContext<HTMLElement>();
+
+   // entrypoints/example.content.ts
+   import ReactDOM from 'react-dom/client';
+   import App from './App.tsx';
+   import PortalTargetContext from '~/hooks/PortalTargetContext';
+
+   const ui = await create`ShadowRoot`Ui(ctx, {
+     // ...
+     onMount: (container, shadow) => {
+       const portalTarget = shadow.querySelector('body')!;
+       const root = ReactDOM.createRoot(container);
+       root.render(
+         <PortalTargetContext.Provider value={portalTarget}>
+           <App />
+         </PortalTargetContext.Provider>,
+       );
+       return root;
+     },
+   });
+   ui.mount();
+   ```
+
+   :::
+
+   Then use the reference when teleporting/portaling part of your UI to a different place in the DOM:
+
+   :::code-group
+
+   ```vue [Vue]
+   <script lang="ts" setup>
+   import { Teleport } from 'vue';
+
+   const teleportTarget = inject('TeleportTarget');
+   </script>
+
+   <template>
+     <div>
+       <Teleport :to="teleportTarget">
+         <dialog>My dialog</dialog>
+       </Teleport>
+     </div>
+   </template>
+   ```
+
+   ```tsx [React]
+   import { useContext } from 'react';
+   import { createPortal } from 'react-dom';
+   import PortalTargetContext from '~/hooks/PortalTargetContext';
+
+   const MyComponent = () => {
+     const portalTarget = useContext(PortalTargetContext);
+
+     return <div>{createPortal(<dialog>My dialog</dialog>, portalTarget)}</div>;
+   };
+   ```
+
+   :::
+
+   ::::::
+
+Both issues have the same cause: the library puts something outside the `ShadowRoot`, and the `ShadowRoot`'s isolation prevents CSS from being applied to your UI.
+
+Both issues have the same fix: tell the library to put elements inside the `ShadowRoot`, not outside it. See the details above for more information and example fixes for each problem.

packages/storage/src/index.ts

@@ -712,7 +712,7 @@ export interface WxtStorage {
   /**
    * Define a storage item with a default value, type, or versioning.
    *
-   * Read full docs: https://wxt.dev/guide/extension-apis/storage.html#defining-storage-items
+   * Read full docs: https://wxt.dev/storage.html#defining-storage-items
    */
   defineItem<TValue, TMetadata extends Record<string, unknown> = {}>(
     key: StorageItemKey,

packages/unocss/README.md

@@ -38,10 +38,10 @@ The module can be configured via the `unocss` config:
 export default defineConfig({
   modules: ['@wxt-dev/unocss'],
   unocss: {
-    // Will only apply unocss for popup/main.ts
-    entrypoints: ['popup/main.ts'],
+    // Exclude unocss from running for the background
+    excludeEntrypoints: ['background'],
   },
 });
 ```
 
-Options have JSDocs available in your editor, or you can read them in the source code: [`UnoCSSOptions`](https://github.com/wxt-dev/wxt/blob/main/packages/auto-icons/src/index.ts).
+Options have JSDocs available in your editor, or you can read them in the source code: [`UnoCSSOptions`](https://github.com/wxt-dev/wxt/blob/main/packages/unocss/src/index.ts).

packages/wxt/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v0.19.24
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.23...wxt-v0.19.24)
+
+### 🩹 Fixes
+
+- **init:** Remove "experimental" from bun package manager ([b150a52](https://github.com/wxt-dev/wxt/commit/b150a52))
+- **web-ext:** Correctly pass `browserConsole` option to open devtools in Firefox ([#1308](https://github.com/wxt-dev/wxt/pull/1308))
+- `autoMount` not working if anchor is already present ([#1350](https://github.com/wxt-dev/wxt/pull/1350))
+
+### 🏡 Chore
+
+- Fix typo in CLI docs ([028c601](https://github.com/wxt-dev/wxt/commit/028c601))
+
+### ❤️ Contributors
+
+- 1natsu ([@1natsu172](http://github.com/1natsu172))
+- Paulo Pinto <regularjack@gmail.com>
+- Aaron ([@aklinker1](http://github.com/aklinker1))
+
 ## v0.19.23
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.22...wxt-v0.19.23)
@@ -2775,4 +2795,4 @@ Initial release of WXT. Full support for production builds and initial toolkit f
 ### 🤖 CI
 
 - Create validation workflow ([#12](https://github.com/wxt-dev/wxt/pull/12))
-- Create release workflow ([#13](https://github.com/wxt-dev/wxt/pull/13))
+- Create release workflow ([#13](https://github.com/wxt-dev/wxt/pull/13))

packages/wxt/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.19.23",
+  "version": "0.19.24",
   "description": "Next gen framework for developing web extensions",
   "repository": {
     "type": "git",

packages/wxt/src/client/content-scripts/ui/__tests__/index.test.ts

@@ -546,6 +546,25 @@ describe('Content Script UIs', () => {
     ] as const)(
       'built-in UI type: $name',
       ({ name, createUiFunction, uiSelector }) => {
+        it('should mount if an anchor already exists at the initialization', async () => {
+          const onMount = vi.fn(appendTestApp);
+          ui = await createUiFunction(ctx, {
+            position: 'inline',
+            onMount,
+            anchor: `#parent > #${DYNAMIC_CHILD_ID}`,
+            page: name === 'iframe' ? '/page.html' : undefined,
+            name: 'test-component',
+          });
+
+          appendTestElement({ id: DYNAMIC_CHILD_ID });
+          ui.autoMount();
+          await runMicrotasks();
+
+          await expect
+            .poll(() => document.querySelector(uiSelector))
+            .not.toBeNull();
+        });
+
         it('should mount when an anchor is dynamically added and unmount when an anchor is removed', async () => {
           const onMount = vi.fn(appendTestApp);
           const onRemove = vi.fn();

packages/wxt/src/client/content-scripts/ui/index.ts

@@ -355,6 +355,11 @@ function autoMountUi(
   async function observeElement(selector: string | null | undefined) {
     let isAnchorExist = !!getAnchor(options);
 
+    // Mount if anchor exists at initialization.
+    if (isAnchorExist) {
+      uiCallbacks.mount();
+    }
+
     while (!abortController.signal.aborted) {
       try {
         const changedAnchor = await waitElement(selector ?? 'body', {

packages/wxt/src/core/runners/web-ext.ts

@@ -35,7 +35,7 @@ export function createWebExtRunner(): ExtensionRunner {
 
       const wxtUserConfig = wxt.config.runnerConfig.config;
       const userConfig = {
-        console: wxtUserConfig?.openConsole,
+        browserConsole: wxtUserConfig?.openConsole,
         devtools: wxtUserConfig?.openDevtools,
         startUrl: wxtUserConfig?.startUrls,
         keepProfileChanges: wxtUserConfig?.keepProfileChanges,