生成的 + 反应路由器 + 类型安全
文档
检查出来 generouted关键 文档 联 合 国 特性, (中文(简体) ), 公约 还有更多.
怎么样
此集成基于一个 Vite 插件,用于生成路由器的路由类型 generouted 公约。 输出默认保存于 src/router.ts ,然后通过添加/更改/删除 src/pages/*。 。 。 .
开始
如果您没有带有 React 和 TypeScript 的 Vite 项目, 请检查 使用文档启动新项目。 。 。 .
安装
pnpm add @generouted/react-router react-router
设置
// 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()] })
使用量
// 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 → /,然后导出默认组件:
// src/pages/index.tsx
export default function Home() {
return <h1>Home</h1>
}
可选的根布局 pages/_app.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
// 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>
)
}
安全型全球模式
虽然所有模式都是全球性的,但与相关航道共同定位模式还是不错的.
创建模式路由, 设置一个带有加号的有效路由文件名 +。为什么 +* 您可以把它看作是一条额外的路线, 因为模式覆盖了当前路线:
// src/pages/+login.tsx
import { Modal } from '@/ui'
export default function Login() {
return <Modal>Content</Modal>
}
导航到模式用途 useModals 导出自 src/router.ts数字 :
// 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 })
实例
反应路由器
许可证
麻省理工学院