Sidebar 侧边导航

介绍

垂直展示的导航栏,用于在不同的内容区域之间进行切换。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Sidebar, SidebarItem } from 'vant';
  3. const app = createApp();
  4. app.use(Sidebar);
  5. app.use(SidebarItem);

代码演示

基础用法

通过 v-model 绑定当前选中项的索引。

  1. <van-sidebar v-model="active">
  2. <van-sidebar-item title="标签名称" />
  3. <van-sidebar-item title="标签名称" />
  4. <van-sidebar-item title="标签名称" />
  5. </van-sidebar>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const active = ref(0);
  5. return { active };
  6. },
  7. };

徽标提示

设置 dot 属性后,会在右上角展示一个小红点;设置 badge 属性后,会在右上角展示相应的徽标。

  1. <van-sidebar v-model="active">
  2. <van-sidebar-item title="标签名称" dot />
  3. <van-sidebar-item title="标签名称" badge="5" />
  4. <van-sidebar-item title="标签名称" badge="20" />
  5. </van-sidebar>

禁用选项

通过 disabled 属性禁用选项。

  1. <van-sidebar v-model="active">
  2. <van-sidebar-item title="标签名称" />
  3. <van-sidebar-item title="标签名称" disabled />
  4. <van-sidebar-item title="标签名称" />
  5. </van-sidebar>

监听切换事件

设置 change 方法来监听切换导航项时的事件。

  1. <van-sidebar v-model="active" @change="onChange">
  2. <van-sidebar-item title="标签名 1" />
  3. <van-sidebar-item title="标签名 2" />
  4. <van-sidebar-item title="标签名 3" />
  5. </van-sidebar>
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  3. export default {
  4. setup() {
  5. const active = ref(0);
  6. const onChange = (index) => Toast(`标签名 ${index + 1}`);
  7. return {
  8. active,
  9. onChange,
  10. };
  11. },
  12. };

API

Sidebar Props

参数说明类型默认值
v-model当前导航项的索引number | string0

Sidebar Events

事件名说明回调参数
change切换导航项时触发index: number

SidebarItem Props

参数说明类型默认值
title内容string‘’
dot是否显示右上角小红点booleanfalse
badge图标右上角徽标的内容number | string-
badge-props v3.2.8自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps-
disabled是否禁用该项booleanfalse
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象,等同于 vue-router 的 to 属性string | object-
replace是否在跳转时替换当前页面历史booleanfalse

SidebarItem Events

事件名说明回调参数
click点击时触发index: number

SidebarItem Slots

NameDescription
title自定义标题

类型定义

组件导出以下类型定义:

  1. import type { SidebarProps, SidebarItemProps } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-sidebar-width80px-
—van-sidebar-font-sizevar(—van-font-size-md)-
—van-sidebar-line-heightvar(—van-line-height-md)-
—van-sidebar-text-colorvar(—van-text-color)-
—van-sidebar-disabled-text-colorvar(—van-text-color-3)-
—van-sidebar-padding20px var(—van-padding-sm)-
—van-sidebar-active-colorvar(—van-active-color)-
—van-sidebar-background-colorvar(—van-background-color)-
—van-sidebar-selected-font-weightvar(—van-font-weight-bold)-
—van-sidebar-selected-text-colorvar(—van-text-color)-
—van-sidebar-selected-border-width4px-
—van-sidebar-selected-border-height16px-
—van-sidebar-selected-border-colorvar(—van-danger-color)-
—van-sidebar-selected-background-colorvar(—van-background-color-light)-

Sidebar 侧边导航 - 图1