# @generouted/tanstack-react-router 中文文档

规范地址：https://npmcn.com/package/%40generouted/tanstack-react-router/

版本：1\.20\.2
npm 元数据更新时间：2026-03-15T14:54:39.313Z
中文译文更新时间：2026-11-16T03:19:54.749Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40generouted/tanstack-react-router
原文对照：https://npmcn.com/package/%40generouted/tanstack-react-router/?lang=original
项目主页：https://github.com/oedotme/generouted#readme
源码仓库：https://github.com/oedotme/generouted

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

- 包体积（解压后）：17.6 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vite \>=5
- 首次发布：2022-12-23T05:44:40.543Z
- 最新版本发布：2026-03-15T14:54:39.162Z
- 近 30 天下载量：2830（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：100（近 12 个月 2 个）

## 中文简介

为 TanStack 反应路由器和 Vite 创建基于文件的路由

## 安装

```sh
npm install @generouted/tanstack-react-router
```

也可以使用：`pnpm add @generouted/tanstack-react-router`、`yarn add @generouted/tanstack-react-router`、`bun add @generouted/tanstack-react-router`

## README

# 生成的 + TanStack 反应路由器

## 怎么样

此集成基于一个 Vite 插件, 用于生成 TanStack React Router 的路由配置 `generouted` 公约。 输出保存于 `src/routes.gen.tsx` ,然后通过添加/更改/删除 `src/pages/*`。 。 。 .

## 开始

如果您没有带有 React 和 TypeScript 的 Vite 项目, 请检查 [使用文档启动新项目](https://vitejs.dev/guide/#scaffolding-your-first-vite-project)。 。 。 .

### 安装

```shell
pnpm add @generouted/tanstack-react-router @tanstack/router@beta
```

用于动作和(或)加载器的可选额外包:

```shell
pnpm add @tanstack/react-actions@beta @tanstack/react-loaders@beta
```

可选安装 `prettier` 因此,作为一个依赖性 `generouted` 格式生成 `src/routes.gen.tsx` 文件自动 :

```shell
pnpm add --save-dev prettier
```

### 设置

```ts
// vite.config.ts

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import generouted from '@generouted/tanstack-react-router'

export default defineConfig({ plugins: [react(), generouted()] })
```

### 使用量

```tsx
// src/main.tsx

import { createRoot } from 'react-dom/client'
import { Routes } from './routes.gen'

createRoot(document.getElementById('root')!).render(<Routes />)
```

### 添加页面

通过创建新文件添加主页 `src/pages/index.tsx` **→** `/`,然后导出默认组件:

```tsx
// src/pages/index.tsx

export default function Home() {
  return <h1>Home</h1>
}
```

### 可选的根布局 `pages/_app.tsx`

```tsx
// src/pages/_app.tsx

import { Outlet } from '@tanstack/router'

export default function App() {
  return (
    <section>
      <header>
        <nav>...</nav>
      </header>

      <main>
        <Outlet />
      </main>
    </section>
  )
}
```

## 实例

### TanStack 反应路由器

-   [基础](https://npmcn.com/package/examples/tanstack-react-router/)

## 许可证

麻省理工学院

## 常见问题

### @generouted/tanstack-react-router 是什么？

为 TanStack 反应路由器和 Vite 创建基于文件的路由

### 如何安装 @generouted/tanstack-react-router？

在项目目录运行 npm install @generouted/tanstack-react-router，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vite（\>=5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @generouted/tanstack-react-router 支持 TypeScript 吗？

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

### @generouted/tanstack-react-router 支持 ESM 还是 CommonJS？

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

### @generouted/tanstack-react-router 可以商用吗？

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

### @generouted/tanstack-react-router 的下载量有多少？

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

### @generouted/tanstack-react-router 还在维护吗？

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

