> ## Documentation Index
> Fetch the complete documentation index at: https://extension.js.org/llms.txt
> Use this file to discover all available pages before exploring further.

# 在瀏覽器擴充功能中使用 React

> 使用 Extension.js 以 React 打造瀏覽器擴充功能的 UI。自動取得 JSX 轉換、別名與開發階段的 fast refresh。

Extension.js 會從專案的相依套件偵測 React，並自動設定 JSX/TSX 轉換、React 的模組別名，以及開發階段的 fast-refresh 支援。

## 什麼情況下適合使用 React

* 你正在打造 popup、options、sidebar、new tab 等內容豐富的 UI 介面。
* 你希望在擴充功能頁面與 content script UI 之間重複使用元件。
* 你已經在 web 專案中使用 React，並希望在擴充功能中採用相同的開發模型。

## 範本範例

### `new-react`

<img src="https://mintcdn.com/extensionjs/VCnDd7fX2Nza24SE/images/examples/new-react/screenshot.png?fit=max&auto=format&n=VCnDd7fX2Nza24SE&q=85&s=f117edc4f887e1571c03cdc4eeedebd3" alt="new-react template screenshot" width="2400" height="1800" data-path="images/examples/new-react/screenshot.png" />

以可立即執行的專案結構打造一個 React new-tab 體驗。

<CodeGroup>
  ```bash npm theme={null}
  npx extension@latest create my-extension --template=new-react
  ```

  ```bash pnpm theme={null}
  pnpx extension@latest create my-extension --template=new-react
  ```

  ```bash yarn theme={null}
  yarn dlx extension@latest create my-extension --template=new-react
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=new-react
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=new-react
  ```
</CodeGroup>

Repository: [extension-js/examples/new-react](https://github.com/extension-js/examples/tree/main/examples/new-react)

### `content-react`

<img src="https://mintcdn.com/extensionjs/VCnDd7fX2Nza24SE/images/examples/content-react/screenshot.png?fit=max&auto=format&n=VCnDd7fX2Nza24SE&q=85&s=a0b8694d3a7dfdbb38944a1a7c183c58" alt="content-react template screenshot" width="2400" height="1800" data-path="images/examples/content-react/screenshot.png" />

以 content script 為主的設定，把 React UI 注入到既有頁面中。

<CodeGroup>
  ```bash npm theme={null}
  npx extension@latest create my-extension --template=content-react
  ```

  ```bash pnpm theme={null}
  pnpx extension@latest create my-extension --template=content-react
  ```

  ```bash yarn theme={null}
  yarn dlx extension@latest create my-extension --template=content-react
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=content-react
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=content-react
  ```
</CodeGroup>

Repository: [extension-js/examples/content-react](https://github.com/extension-js/examples/tree/main/examples/content-react)

### `new-react-router`

<img src="https://mintcdn.com/extensionjs/VCnDd7fX2Nza24SE/images/examples/new-react-router/screenshot.png?fit=max&auto=format&n=VCnDd7fX2Nza24SE&q=85&s=58583c4dd35f487acddc923c4214773a" alt="new-react-router template screenshot" width="2400" height="1800" data-path="images/examples/new-react-router/screenshot.png" />

以 React Router 在 React 擴充功能中加入 client-side 路由。

<CodeGroup>
  ```bash npm theme={null}
  npx extension@latest create my-extension --template=new-react-router
  ```

  ```bash pnpm theme={null}
  pnpx extension@latest create my-extension --template=new-react-router
  ```

  ```bash yarn theme={null}
  yarn dlx extension@latest create my-extension --template=new-react-router
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=new-react-router
  ```

  ```bash bun theme={null}
  bunx extension@latest create my-extension --template=new-react-router
  ```
</CodeGroup>

Repository: [extension-js/examples/new-react-router](https://github.com/extension-js/examples/tree/main/examples/new-react-router)

## 在既有擴充功能中使用

依下列步驟把 React 加入既有擴充功能。

### 安裝

安裝 React 執行期相依套件：

<PackageManagerTabs command="install react react-dom" />

如果你使用 TypeScript，也安裝 React 的型別套件：

<PackageManagerTabs command="install -D @types/react @types/react-dom" />

### 設定

常見的 React 檔案命名：

* JavaScript：`*.jsx`
* TypeScript：`*.tsx`

## 開發行為

在開發模式下，Extension.js 偵測到 React 時會啟用 React refresh 整合。

* Extension.js 會使用 `react-refresh` 與 `@rspack/plugin-react-refresh` 提供 refresh 行為。
* 若專案缺少選用的 refresh 相依套件，Extension.js 會自動安裝並提示重新啟動。
* Extension.js 會套用 React 別名，讓 bundle 中只保留單一份 React/runtime 實例。

## 使用範例

### 在 new tab 擴充功能中

頁面入口範例：

```html theme={null}
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>New Extension</title>
  </head>
  <body>
    <noscript>You need to enable JavaScript to run this extension.</noscript>
    <div id="root"></div>
  </body>
  <script src="./index.tsx"></script>
</html>
```

```tsx theme={null}
import React from "react";
import ReactDOM from "react-dom/client";
import App from "./App";

const root = ReactDOM.createRoot(document.getElementById("root"));

root.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
);
```

```tsx theme={null}
export default function App() {
  return <h1>Hello, Extension!</h1>;
}
```

### 在 `content_script` 檔中

對於 content script，把 React 渲染到注入的根節點：

```tsx theme={null}
import React from "react";
import ReactDOM from "react-dom/client";
import App from "./App";
import "./content.css";

const rootDiv = document.createElement("div");
rootDiv.id = "extension-root";
document.body.appendChild(rootDiv);

const root = ReactDOM.createRoot(rootDiv);
root.render(<App />);
```

## 下一步

* 進一步了解 [TypeScript 支援](/docs/languages-and-frameworks/typescript)。
* 探索 Extension.js 如何處理 [Sass modules](/docs/languages-and-frameworks/sass)。

## 影片導覽