SuperAPI AI 工具集

virtual-file-routes

通用与其它

查看项目

更新于 10-16 00:00

技能介绍

用途:以编程方式构建路由树,替代单纯依赖文件系统约定,适合需要显式控制路由结构、混合虚拟与物理路由,或在文件式路由目录内定义路由子树的场景。

主要能力:提供 rootRoute(file, children?)、index(file)、route(path, ...)、layout(file, children) 或 layout(id, file, children)、physical(pathPrefix, directory) 或 physical(directory),以及 defineVirtualSubtreeConfig(config) 类型辅助函数。route 支持三种签名:叶子路由(路径+文件)、分支路由(路径+文件+子路由)、仅路径前缀(无文件,用于分组子路由)。layout 创建无路径布局路由,不增加 URL 段。physical 将文件式路由目录挂载到 URL 前缀。

使用方式:安装 npm install @tanstack/virtual-file-routes。在 vite.config.ts 中通过 tanstackRouter({ target: 'react', virtualRouteConfig: routes }) 传入配置,或使用 virtualRouteConfig: './routes.ts' 引用文件路径。在文件式路由目录内可用 __virtual.ts 配合 defineVirtualSubtreeConfig。

限制与注意:类型完全推断,不要强制转换或标注推断值。文件路径相对于路由插件的 routesDirectory(默认 ./src/routes),不要使用绝对路径或项目根相对路径。physical() 传入的目录必须存在于 routesDirectory 内并遵循 TanStack Router 文件式路由约定。layout() 不添加 URL 段,需要 URL 段应使用 route()。

资料未提供收费、价格、平台支持范围及效果数据。