VuePress侧边栏配置与useSidebar的使用方式

 更新时间:2025年06月16日 09:47:43   作者:红衣大叔  
这篇文章主要介绍了VuePress侧边栏配置与useSidebar的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

VuePress侧边栏配置与useSidebar的使用

在VuePress中,侧边栏(Sidebar)是一个重要的组成部分,用于组织文档结构,提供给用户方便的导航体验。

本文将详细介绍如何配置侧边栏,并介绍如何使用 useSidebar 组合式函数来操作侧边栏的状态。

单一侧边栏的配置

最简单的侧边栏配置方式是通过一个数组来定义导航结构。每个第一级的项目定义了一个“部分”(section),它应该包含一个文本标题(text)以及实际的导航链接(items)。

  • 例如:
export default {
  themeConfig: {
    sidebar: [
      {
        text: 'Section Title A',
        items: [
          { text: 'Item A', link: '/item-a' },
          { text: 'Item B', link: '/item-b' },
          // 更多子项...
        ]
      },
      {
        text: 'Section Title B',
        items: [
          { text: 'Item C', link: '/item-c' },
          { text: 'Item D', link: '/item-d' },
          // 更多子项...
        ]
      }
    ]
  }
}

每个链接应指定以 / 开头的实际文件路径。如果链接的末尾加上斜杠,则表示指向对应目录下的 index.md 文件。

多个侧边栏的配置

你可以根据页面路径来显示不同的侧边栏。例如,你可以为不同的文档部分配置单独的侧边栏。

  • 首先按需组织Markdown文件:
.
├─ guide/
│  ├─ index.md
│  ├─ one.md
│  └─ two.md
└─ config/
   ├─ index.md
   ├─ three.md
   └─ four.md
  • 然后更新配置文件以定义每个部分的侧边栏:
export default {
  themeConfig: {
    sidebar: {
      '/guide/': [
        {
          text: 'Guide',
          items: [
            { text: 'Index', link: '/guide/' },
            { text: 'One', link: '/guide/one' },
            { text: 'Two', link: '/guide/two' }
          ]
        }
      ],
      '/config/': [
        {
          text: 'Config',
          items: [
            { text: 'Index', link: '/config/' },
            { text: 'Three', link: '/config/three' },
            { text: 'Four', link: '/config/four' }
          ]
        }
      ]
    }
  }
}

可折叠的侧边栏组

在侧边栏中添加可折叠的功能,可以让用户通过点击切换按钮来隐藏或显示某个部分的内容。这有助于在内容较多的情况下保持界面的整洁,并提供更好的用户体验。

要配置可折叠的侧边栏组,可以在定义侧边栏的配置中为每个部分添加一个 collapsed 属性。

  • 例如:
export default {
  themeConfig: {
    sidebar: [
      {
        text: 'Section Title A',
        collapsed: false, // 默认展开
        items: [
          { text: 'Item A', link: '/item-a' },
          { text: 'Item B', link: '/item-b' },
          // 更多子项...
        ]
      },
      {
        text: 'Section Title B',
        collapsed: true, // 默认收起
        items: [
          { text: 'Item C', link: '/item-c' },
          { text: 'Item D', link: '/item-d' },
          // 更多子项...
        ]
      }
    ]
  }
}

使用 useSidebar 组合式函数

  • useSidebar 是一个组合式函数,提供了与侧边栏相关数据的访问。它返回一个包含多个响应式引用(Ref)和一些实用函数的对象。
export interface DocSidebar {
  isOpen: Ref<boolean>,
  sidebar: ComputedRef<DefaultTheme.SidebarItem[]>,
  sidebarGroups: ComputedRef<DefaultTheme.SidebarItem[]>,
  hasSidebar: ComputedRef<boolean>,
  hasAside: ComputedRef<boolean>,
  leftAside: ComputedRef<boolean>,
  isSidebarEnabled: ComputedRef<boolean>,
  open: () => void,
  close: () => void,
  toggle: () => void
}
  • 使用 useSidebar 的示例如下:
<script setup>
import { useSidebar } from '@vuepress/theme-default';

const { hasSidebar } = useSidebar();
</script>

<template>
  <div v-if="hasSidebar">仅在存在侧边栏时显示</div>
</template>

通过这种方式,你可以更灵活地管理和控制侧边栏的行为,以增强用户体验并使页面布局更加动态和响应式。

总结

通过合理的侧边栏配置,可以显著提升文档的导航性和用户体验。无论是单一的侧边栏还是根据不同路径显示的多个侧边栏,VuePress 都提供了丰富的配置选项。同时,useSidebar 组合式函数进一步增强了侧边栏的交互性和动态性。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • vue双向绑定及观察者模式详解

    vue双向绑定及观察者模式详解

    这篇文章主要介绍了vue双向绑定及观察者模式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • 关于vue2使用swiper4的踩坑记录

    关于vue2使用swiper4的踩坑记录

    最近写vue的一个练手项目需要在里面实现一个轮播图,想到去用第三方插件,百度了一轮,发现大部分都是swiper这个插件,这篇文章主要给大家介绍了关于vue2使用swiper4踩坑的相关资料,需要的朋友可以参考下
    2022-01-01
  • Vue3中Vite和Vue-cli的特点与区别详解

    Vue3中Vite和Vue-cli的特点与区别详解

    vue-cli是Vue早期推出的一款脚手架,使用webpack创建Vue项目,可以选择安装需要的各种插件,比如Vuex、VueRouter,下面这篇文章主要给大家介绍了关于Vue3中Vite和Vue-cli的特点与区别的相关资料,需要的朋友可以参考下
    2022-12-12
  • 如何使用vue-json-viewer插件展示JSON格式数据

    如何使用vue-json-viewer插件展示JSON格式数据

    这篇文章主要给大家介绍了关于如何使用vue-json-viewer插件展示JSON格式数据的相关资料,Vue-json-viewer是一个Vue组件,用于在Vue应用中显示JSON数据的可视化工具,需要的朋友可以参考下
    2023-11-11
  • 基于Vue+ELement搭建动态树与数据表格实现分页模糊查询实战全过程

    基于Vue+ELement搭建动态树与数据表格实现分页模糊查询实战全过程

    这篇文章主要给大家介绍了关于如何基于Vue+ELement搭建动态树与数据表格实现分页模糊查询的相关资料,Vue Element UI提供了el-pagination组件来实现表格数据的分页功能,需要的朋友可以参考下
    2023-10-10
  • vue项目实现搜索内容变红色显示

    vue项目实现搜索内容变红色显示

    这篇文章主要为大家介绍了vue项目实现搜索内容变红色显示,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • vue中使用TypeScript的方法

    vue中使用TypeScript的方法

    这篇文章主要介绍了vue中使用TypeScript的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • Vue Router动态路由实现实现更灵活的页面交互

    Vue Router动态路由实现实现更灵活的页面交互

    Vue Router是Vue.js官方的路由管理器,用于构建SPA(单页应用程序),本文将深入探讨Vue Router的动态路由功能,希望可以帮助大家更好地理解和应用Vue.js框架
    2024-02-02
  • 在Vue3项目中关闭ESLint的完整步骤

    在Vue3项目中关闭ESLint的完整步骤

    实际上在学习过程中,你会发现eslint检查特别讨厌,这个时候我们需要关闭掉eslint检查,下面这篇文章主要给大家介绍了关于在Vue3项目中关闭ESLint的完整步骤,需要的朋友可以参考下
    2023-11-11
  • vue 获取元素额外生成的data-v-xxx操作

    vue 获取元素额外生成的data-v-xxx操作

    这篇文章主要介绍了vue 获取元素额外生成的data-v-xxx操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09

最新评论