Sidebar 侧边导航

引入

import { createApp } from 'vue';
import { Sidebar, SidebarItem } from 'vant';

const app = createApp();
app.use(Sidebar);
app.use(SidebarItem);

代码演示

基础用法

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

<van-sidebar v-model="activeKey">
  <van-sidebar-item title="标签名称" />
  <van-sidebar-item title="标签名称" />
  <van-sidebar-item title="标签名称" />
</van-sidebar>
export default {
  data() {
    return {
      activeKey: 0,
    };
  },
};

徽标提示

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

<van-sidebar v-model="activeKey">
  <van-sidebar-item title="标签名称" dot />
  <van-sidebar-item title="标签名称" badge="5" />
  <van-sidebar-item title="标签名称" badge="99+" />
</van-sidebar>

禁用选项

通过 disabled 属性禁用选项。

<van-sidebar v-model="activeKey">
  <van-sidebar-item title="标签名称" />
  <van-sidebar-item title="标签名称" disabled />
  <van-sidebar-item title="标签名称" />
</van-sidebar>

监听切换事件

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

<van-sidebar v-model="activeKey" @change="onChange">
  <van-sidebar-item title="标签名1" />
  <van-sidebar-item title="标签名2" />
  <van-sidebar-item title="标签名3" />
</van-sidebar>
import { Notify } from 'vant';

export default {
  data() {
    return {
      activeKey: 0,
    };
  },
  methods: {
    onChange(index) {
      Notify({ type: 'primary', message: index });
    },
  },
};

API

Sidebar Props

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

Sidebar Events

事件名 说明 回调参数
change 切换导航项时触发 index: 当前导航项的索引

SidebarItem Props

参数 说明 类型 默认值
title 内容 string ''
dot 是否显示右上角小红点 boolean false
badge v2.5.6 图标右上角徽标的内容 number / string -
disabled 是否禁用该项 boolean false
url 点击后跳转的链接地址 string -
to 点击后跳转的目标路由对象,同 vue-router 的 to 属性 string / object -
replace 是否在跳转时替换当前页面历史 boolean false

SidebarItem Events

事件名 说明 回调参数
click 点击时触发 index: 当前导航项的索引

SidebarItem Slots

Name Description
title v2.10.8 自定义标题