@generouted/tanstack-react-router

中文文档
1.20.2发布于 2026/03/15MITTypeScriptESM + CJS近 30 天下载 2830

Generated file-based routes for TanStack React Router and Vite

原始使用文档
文档目录10 节
  1. How
  2. Getting started
  3. Installation
  4. Setup
  5. Usage
  6. Adding pages
  7. Optional root layout at pages/_app.tsx
  8. Examples
  9. TanStack React Router
  10. License

Generouted + TanStack React Router

How

This integration is based on a Vite plugin to generate routes config for TanStack React Router with generouted conventions. The output is saved at src/routes.gen.tsx and gets updated by the add/change/delete at src/pages/*.

Getting started

In case you don't have a Vite project with React and TypeScript, check Vite documentation to start a new project.

Installation

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

Optional additional packages for actions and/or loaders:

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

Optionally install prettier as a dev dependency so generouted formats the generated src/routes.gen.tsx file automatically:

pnpm add --save-dev prettier

Setup

// 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()] })

Usage

// src/main.tsx

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

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

Adding pages

Add the home page by creating a new file src/pages/index.tsx → /, then export a default component:

// src/pages/index.tsx

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

Optional root layout at pages/_app.tsx

// src/pages/_app.tsx

import { Outlet } from '@tanstack/router'

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

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

Examples

TanStack React Router

License

MIT

版本与发布记录

@generouted/tanstack-react-router 共发布 100 个版本,首次发布于 2022/12/23;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.20.2latest2026/03/158 个月前
1.20.12026/03/148 个月前
1.20.02025/02/081.8 年前
1.19.112025/02/071.8 年前
1.19.102025/01/121.8 年前
1.19.92024/11/052 年前

关于 @generouted/tanstack-react-router 的常见问题

@generouted/tanstack-react-router 是什么?

Generated file-based routes for TanStack React Router and 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 和提交记录判断。