# @generouted/react-router 中文文档

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

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

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

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

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

- 包体积（解压后）：43.6 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=18，react-router \>=7，vite \>=5
- 首次发布：2023-01-20T06:53:49.145Z
- 最新版本发布：2026-03-15T14:54:33.085Z
- 近 30 天下载量：280964（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 2 个）

## 中文简介

为 React 路由器和 Vite 生成基于文件的路由

## 安装

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

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

## README

# 生成的 + 反应路由器 + 类型安全

## 文档

检查出来 `generouted`关键 [文档](https://npmcn.com/) 联 合 国 [特性](https://npmcn.com/#features), (中文(简体) ), [公约](https://npmcn.com/#conventions) 还有更多.

## 怎么样

此集成基于一个 Vite 插件,用于生成路由器的路由类型 `generouted` 公约。 输出默认保存于 `src/router.ts` ,然后通过添加/更改/删除 `src/pages/*`。 。 。 .

## 开始

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

### 安装

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

### 设置

```ts
// vite.config.ts

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

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

### 使用量

```tsx
// src/main.tsx

import { createRoot } from 'react-dom/client'
import { Routes } from '@generouted/react-router'
// import { Routes } from '@generouted/react-router/lazy' // route-based code-splitting

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 'react-router'

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

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

### 类型安全导航

自动补全 `Link`, (中文(简体) ), `useNavigate`, (中文(简体) ), `useParams` 和更多从 `src/router.ts`

```tsx
// src/pages/index.tsx
import { Link, useNavigate, useParams } from '../router'

export default function Home() {
  const navigate = useNavigate()

  // typeof params -> { id: string; pid?: string }
  const params = useParams('/posts/:id/:pid?')

  // typeof params to be passed -> { id: string; pid?: string }
  const handler = () => navigate('/posts/:id/:pid?', { params: { id: '1', pid: '0' } })

  return (
    <div>
      {/** ✅ Passes  */}
      <Link to="/" />
      <Link to="/posts/:id" params={{ id: '1' }} />
      <Link to="/posts/:id/:pid?" params={{ id: '1' }} />
      <Link to="/posts/:id/:pid?" params={{ id: '1', pid: 0 }} />

      {/** 🔴 Error: not defined route  */}
      <Link to="/not-defined-route" />

      {/** 🔴 Error: missing required params */}
      <Link to="/posts/:id" />

      <h1>Home</h1>
    </div>
  )
}
```

### 安全型全球模式

虽然所有模式都是全球性的,但与相关航道共同定位模式还是不错的.

创建模式路由, 设置一个带有加号的有效路由文件名 `+`。为什么 `+`\* 您可以把它看作是一条额外的路线, 因为模式覆盖了当前路线:

```tsx
// src/pages/+login.tsx

import { Modal } from '@/ui'

export default function Login() {
  return <Modal>Content</Modal>
}
```

导航到模式用途 `useModals` 导出自 `src/router.ts`数字 :

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

import { Outlet } from 'react-router'

import { useModals } from '../router'

export default function App() {
  const modals = useModals()

  return (
    <section>
      <header>
        <nav>...</nav>
        <button onClick={() => modals.open('/login')}>Open modal</button>
      </header>

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

与 `useModals` 您可以使用 `modals.open('/modal-path')` 财务报告和审定财务报表 `modals.close()`,默认情况下,它打开/关闭当前活动路由上的模式.

两种方法都与React Router的 `navigate()` 选项,并添加一个道具 `at`,对于在打开/关闭一种模式时可选择地通向一条路线,它也具有类型安全性!

-   `modals.open(path, options)`
-   `modals.close(options)`

`at` 这里有一些用法示例:

-   `modals.open('/login', { at: '/auth', replace: true })`
-   `modals.open('/info', { at: '/invoice/:id', params: { id: 'xyz' } })`
-   `modals.close({ at: '/', replace: false })`

## 实例

### 反应路由器

-   [插件](https://npmcn.com/examples/react-router)

## 许可证

麻省理工学院

## 常见问题

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

为 React 路由器和 Vite 生成基于文件的路由

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

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

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

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

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

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

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

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

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

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

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

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

