useDocsNavigation() 返回 useDocsShell 在 app.vue 中 provide 的导航树,已按当前语言加载并转换好。
用法
app/components/SectionList.vue
<script setup lang="ts">
const navigation = useDocsNavigation()
</script>
<template>
<ul>
<li v-for="section in navigation" :key="section.path">
<NuxtLink :to="section.path">
{{ section.title }}
</NuxtLink>
</li>
</ul>
</template>
签名
function useDocsNavigation(): Ref<ContentNavigationItem[] | undefined>
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| (返回值本身) | Ref<ContentNavigationItem[] | undefined> | 文档根下的顶层栏目列表,每项的 children 为栏目内页面;页面 frontmatter 中的 category 与 description 会保留在节点上 |
注意事项
- 必须在
app.vue或error.vue的组件树内调用。在外壳之外(例如自定义app.vue未调用useDocsShell)会得到值为undefined的 ref。 - 注入 key 为字符串
'navigation'。v2 中直接inject('navigation')的代码仍然可用,新代码请改用本函数。 - 需要按分类分组或生成面包屑时,把返回值传给
useNavigation。
更新日志
No recent changes