---
title: "useDocsNavigation"
description: "读取外壳预先加载好的文档导航树。页头栏目条、侧栏和文档页都从这里拿导航数据，自定义组件调用它即可复用同一份数据，不会再次查询内容集合。"
canonical_url: "https://docs.mhaibaraai.cn/docs/reference/composables/use-docs-navigation"
---
# useDocsNavigation

> 读取外壳预先加载好的文档导航树。页头栏目条、侧栏和文档页都从这里拿导航数据，自定义组件调用它即可复用同一份数据，不会再次查询内容集合。

`useDocsNavigation()` 返回 [`useDocsShell`](https://docs.mhaibaraai.cn/docs/reference/composables/use-docs-shell) 在 `app.vue` 中 `provide` 的导航树，已按当前语言加载并转换好。

## 用法

```vue [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>
```

## 签名

```ts
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`](https://docs.mhaibaraai.cn/docs/reference/composables/use-navigation)。

## 更新日志

See commit history for [layer/app/composables/useDocsShell.ts](https://github.com/mhaibaraai/movk-nuxt-docs/commits/main/layer/app/composables/useDocsShell.ts).

---

- [GitHub](https://github.com/mhaibaraai/movk-nuxt-docs/blob/main/layer/app/composables/useDocsShell.ts)


## Sitemap

See the full [sitemap](https://docs.mhaibaraai.cn/sitemap.md) for all pages.
