useNavigation() 接收导航树,返回三种派生数据。默认侧栏 DocsAsideLeftBody 与文档页面包屑都基于它实现。
用法
app/components/DocsAsideLeftBody.vue
<script setup lang="ts">
const navigation = useDocsNavigation()
const { navigationByCategory } = useNavigation(navigation)
</script>
<template>
<section v-for="group in navigationByCategory" :key="group.title">
<p>{{ group.title }}</p>
<UContentNavigation :navigation="group.children" />
</section>
</template>
签名
function useNavigation(navigation: Ref<ContentNavigationItem[] | undefined>): {
rootNavigation: ComputedRef<ContentNavigationItem[]>
navigationByCategory: ComputedRef<ContentNavigationItem[]>
findBreadcrumb: (path: string) => BreadcrumbItem[]
}
参数
| 名称 | 类型 | 说明 |
|---|---|---|
navigation | Ref<ContentNavigationItem[] | undefined> | 文档导航树,通常来自 useDocsNavigation() |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
rootNavigation | ComputedRef<ContentNavigationItem[]> | 文档根下的顶层栏目,页头栏目条使用它 |
navigationByCategory | ComputedRef<ContentNavigationItem[]> | 当前路由所在栏目的页面分组,规则见下文 |
findBreadcrumb | (path: string) => BreadcrumbItem[] | 返回从栏目到指定路径的面包屑,每项为 { label, to } 形式的链接(不含图标),可直接传给 UBreadcrumb(BreadcrumbItem 来自 @nuxt/ui) |
分组规则
navigationByCategory 以路由的第一段 slug 确定当前栏目,把栏目内页面分为三类,按以下顺序输出:
- 没有
category、也没有子目录的页面,归入「概览」分组(文案来自内置翻译docs.overview)。 - 子目录,每个子目录成为一个分组,例如参考区的「组合式函数」。
- 带
category的页面,按app.config中docs.categories[栏目 slug]声明的顺序分组;未声明的category不会显示。
app/app.config.ts
export default defineAppConfig({
docs: {
categories: {
guide: [
{ id: 'basics', title: { 'zh-CN': '基础', 'en': 'Basics' }, icon: 'i-lucide-settings' }
]
}
}
})
content/docs/2.guide/1.configuration.md
---
title: 配置
category: basics
---
切换语言的瞬间,如果导航数据仍属于上一个语言,navigationByCategory 返回空数组,避免用错误语言的树渲染当前页。
相关
更新日志
No recent changes