API 参考

本节包含 vitarx-router 所有公共 API 的详细参考文档，包括路由工厂函数、Router 实例方法、类型接口、组件、组合式函数、导航工具以及文件路由插件。

路由工厂

• createRouter() — 自动检测环境创建路由实例
• createWebRouter() — 创建 Web 路由实例
• createMemoryRouter() — 创建内存模式路由实例
• defineRoutes() — 定义路由表
• RouteManager — 路由注册表管理器

Router 实例

• router.push() — 编程式导航
• router.replace() — 替换当前路由
• router.go() — 历史记录导航
• router.back() — 后退
• router.forward() — 前进
• router.beforeEach() — 注册全局前置守卫
• router.afterEach() — 注册全局后置钩子
• router.addRoute() — 动态添加路由
• router.removeRoute() — 动态移除路由
• router.hasRoute() — 检查路由是否存在
• router.init() — 手动初始化路由
• router.isReady() — 等待路由就绪
• router.destroy() — 销毁路由实例
• router.route — 当前路由信息
• router.routes — 路由记录数组

路由位置

• RouteLocation — 路由位置对象
• RouteRecord — 路由记录对象

组件

• RouterView — 路由视图组件
• RouterLink — 路由链接组件

组合式函数

• useRouter() — 获取路由实例
• useRoute() — 获取当前路由信息
• useLink() — 创建链接助手
• onBeforeRouteLeave() — 组件内离开守卫
• onBeforeRouteUpdate() — 组件内更新守卫

导航

• NavigateResult — 导航结果
• NavState — 导航状态枚举
• hasSuccess() — 检查导航是否成功
• hasState() — 按位检查导航状态

文件路由

• FileRouter — 文件路由管理器
• FileRouterOptions — 文件路由配置选项
• definePage() — 页面路由配置宏

Vite 插件

• VitarxRouter() — Vite 文件路由插件
• handleHotUpdate() — 路由热更新处理