# @frontend-testing/vitest-browser-navigate 中文文档

规范地址：https://npmcn.com/package/%40frontend-testing/vitest-browser-navigate/

版本：0\.0\.1-alpha\.8
npm 元数据更新时间：2026-01-01T16:29:11.525Z
中文译文更新时间：2026-11-15T14:51:24.418Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40frontend-testing/vitest-browser-navigate
原文对照：https://npmcn.com/package/%40frontend-testing/vitest-browser-navigate/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.5 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：vitest \>=4\.0\.0
- 首次发布：2025-12-12T19:02:34.924Z
- 最新版本发布：2026-01-01T16:29:11.329Z
- 近 30 天下载量：3701（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

Vitest 浏览器模式的浏览器导航命令

## 安装

```sh
npm install @frontend-testing/vitest-browser-navigate
```

也可以使用：`pnpm add @frontend-testing/vitest-browser-navigate`、`yarn add @frontend-testing/vitest-browser-navigate`、`bun add @frontend-testing/vitest-browser-navigate`

## README

# @ 前端测试/ vitest- browser- navigate

Vitest浏览器模式的浏览器导航命令. 通过更新浏览器历史并发送流行态事件来模拟SPA导航.

## 特征

-   🧭 **SPA 导航** - 在浏览器测试中进行程序导航
-   🎭 **剧作家支持** - 与 `@vitest/browser-playwright`
-   🚗 **网络司机支持** - 与 `@vitest/browser-webdriverio`
-   📦 **类型脚本** - 自动提供全套支持 `commands.navigate()` 类型

## 安装

```bash
npm install -D @frontend-testing/vitest-browser-navigate
```

**同伴依赖关系 :** `vitest >= 4.0.0`

## 快速启动

### 1\. 配置维特

```typescript
// vitest.config.ts
import { navigate } from "@frontend-testing/vitest-browser-navigate";
import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    browser: {
      enabled: true,
      provider: "playwright", // or "webdriverio"
      instances: [{ browser: "chromium" }],
      commands: { navigate },
    },
  },
});
```

### 2\. 测试中的使用

```typescript
import { commands } from "vitest/browser";

describe("MyPage", () => {
  it("navigates to dashboard", async () => {
    await commands.navigate("/dashboard");
    expect(window.location.pathname).toBe("/dashboard");
  });
});
```

## 类型脚本支持

类型 `commands.navigate()` 自动包含。 如果您的 IDE 不识别类型, 请添加副作用导入 :

**选项A:在测试设置文件中( 建议)**

```typescript
// src/test/setup.ts
import "@frontend-testing/vitest-browser-navigate";
// ... rest of your setup
```

**选择B:在单个测试文件中**

```typescript
// my-component.spec.tsx
import "@frontend-testing/vitest-browser-navigate";
import { commands } from "vitest/browser";

// Now commands.navigate() has full type support
await commands.navigate("/dashboard");
```

> **说明:** 添加导入后, 您可能需要重新启动您的 TypeScript 服务器(`Cmd+Shift+P` ~"TypeScript:重新启动TS服务器".

## API 密码

### `commands.navigate(path: string): Promise<void>`

导航到指定的路径:

1.  通话 `window.history.pushState()`
2.  调度a `popstate` 事件( 触发 SPA 路由器, 如 React 路由器)
3.  等待浏览器处理导航

```typescript
// Basic navigation
await commands.navigate("/login");

// With route parameters
await commands.navigate("/users/123");

// With query parameters
await commands.navigate("/search?q=test&page=1");
```

## 如何运作

命令在浏览器上下文中执行并模拟导航,而无需完整页面再加载 - 准确的SPA路由器如何工作. 这使得它非常适合测试React Router,Vue Router,或任何其他客户端的路由解决方案.

## 许可证

麻省理工学院

## 常见问题

### @frontend-testing/vitest-browser-navigate 是什么？

Vitest 浏览器模式的浏览器导航命令

### 如何安装 @frontend-testing/vitest-browser-navigate？

在项目目录运行 npm install @frontend-testing/vitest-browser-navigate，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vitest（\>=4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @frontend-testing/vitest-browser-navigate 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @frontend-testing/vitest-browser-navigate 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @frontend-testing/vitest-browser-navigate 可以商用吗？

@frontend-testing/vitest-browser-navigate 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @frontend-testing/vitest-browser-navigate 的下载量有多少？

根据 npm 官方下载统计，@frontend-testing/vitest-browser-navigate 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,701 次，日均约 123 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @frontend-testing/vitest-browser-navigate 还在维护吗？

最新版本 0\.0\.1-alpha\.8 发布于 2026/01/02（10 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2025/12/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。