Project Icon

router

为Vue.js提供类型安全的路由库

@kitbag/router是专为Vue.js开发的路由库,注重类型安全性。这个库提供了定义路由、导航和管理应用状态的API。它支持嵌套路由、参数更新和声明式导航功能。@kitbag/router的设计目标是简化Vue.js应用中复杂路由逻辑的实现过程。

@kitbag/router

Vue.js 的类型安全路由器

NPM 版本 Netlify 状态 Discord 聊天 在 StackBlitz 中打开

入门

通过我们的文档开始使用

安装

# bun
bun add @kitbag/router
# yarn
yarn add @kitbag/router
# npm
npm install @kitbag/router

定义基本路由

创建一个可能路由的数组。了解更多关于定义路由的信息。

// /routes.ts
import { createRoute } from '@kitbag/router'

const Home = { template: '<div>首页</div>' }
const About = { template: '<div>关于</div>' }

export const routes = [
  createRoute({ name: 'home', path: '/', component: Home }),
  createRoute({ name: 'path', path: '/about', component: About }),
]

插件

创建一个路由器实例并将其作为插件传递给应用程序

import { createApp } from 'vue'
import { createRouter } from '@kitbag/router'
import { routes } from '/routes'
import App from './App.vue'

const router = createRouter(routes)
const app = createApp(App)

app.use(router)
app.mount('#app')

更新注册的路由器

此代码块利用声明合并来提供与实际使用的路由器匹配的内部类型。您可以在调用 createRouter 后立即将此代码放在 main.ts 中,或者导出您的路由器并将此接口放在 router.d.ts 文件中,只要您的 tsconfig 可以找到它即可。

declare module '@kitbag/router' {
  interface Register {
    router: typeof router
  }
}

推送

要导航到另一个路由,您可以使用 router.push。此方法将更新浏览器的 URL,并将 URL 添加到历史记录中,以便用户使用浏览器的后退按钮时能够按预期工作。

import { createRoute, useRouter } from '@kitbag/router'

const user = createRoute({
  name: 'user',
  path: '/user',
  component: ...,
})

const profile = createRoute({
  parent: user,
  name: 'profile',
  path: '/profile',
  component: ...,
})

const settings = createRoute({
  parent: user,
  name: 'settings',
  path: '/settings',
  component: ...,
})

const router = useRouter([user, profile, settings])

router.push('user.settings')

如果您知道要跳转的 URL,push 方法也接受普通字符串。

router.push('/user/settings')
router.push('https://github.com/kitbagjs/router')

这个 source 参数是类型安全的,期望是 Url 或有效的路由 "key"。Url 是以 "http"、"https" 或正斜杠 "/" 开头的任何字符串。路由 key 是由句点 . 连接的路由名称字符串。此外,如果使用路由 key,如果有任何参数,push 将要求传入参数。

更新

如果您只想更改当前路由的参数,可以使用 router.route.update

router.route.update('myParam', 123)

或一次设置多个参数

router.route.update({
  myParam: 123,
  tab: 'github',
})

RouterView

为您的路由组件提供一个挂载位置

<!-- App.vue -->
<div class="app">
  ...
  <!-- 匹配的 route.component 在这里渲染 -->
  <router-view />
</div>

这个组件可以挂载在您想要挂载路由组件的任何位置。嵌套路由也可以有一个嵌套的 RouterView,负责渲染该路由可能拥有的任何子路由。阅读更多关于嵌套路由的信息。

RouterLink

使用 RouterLink 在路由之间导航。

<template>
  ...
  <!-- router-link 渲染为带有 href 的 <a> 标签 -->
  <router-link :to="(resolve) => resolve('home')">前往某处</router-link>
</template>

这个组件使路由器能够在不重新加载页面的情况下更改 URL。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号