Sidebar 侧边导航

引入

app.jsonindex.json中引入组件,详细介绍见快速上手

  1. "usingComponents": {
  2. "van-sidebar": "path/to/@vant/weapp/dist/sidebar/index",
  3. "van-sidebar-item": "path/to/@vant/weapp/dist/sidebar-item/index"
  4. }

Vant Weapp 1.0 版本开始支持此组件,升级方式参见快速上手

代码演示

基础用法

通过在van-sidebar上设置activeKey属性来控制选中项

  1. <van-sidebar active-key="{{ activeKey }}" bind:change="onChange">
  2. <van-sidebar-item title="标签名称" />
  3. <van-sidebar-item title="标签名称" />
  4. <van-sidebar-item title="标签名称" />
  5. </van-sidebar>
  1. Page({
  2. data: {
  3. activeKey: 0
  4. },
  5. onChange(event) {
  6. wx.showToast({
  7. icon: 'none',
  8. title: `切换至第${event.detail}项`
  9. });
  10. }
  11. });

提示信息

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

  1. <van-sidebar active-key="{{ activeKey }}">
  2. <van-sidebar-item title="标签名称" dot />
  3. <van-sidebar-item title="标签名称" info="5" />
  4. <van-sidebar-item title="标签名称" info="99+" />
  5. </van-sidebar>

API

Sidebar Props

参数说明类型默认值版本
activeKey选中项的索引string | number0-

Sidebar Event

事件名说明参数
change切换徽章时触发当前选中徽章的索引

Sidebar 外部样式类

类名说明
custom-class根节点样式类

SidebarItem Props

参数说明类型默认值版本
title内容string''-
dot是否显示右上角小红点booleanfalse-
info提示消息string | number''-

SidebarItem Event

事件名说明参数
click点击徽章时触发当前徽章的索引

SidebarItem 外部样式类

类名说明
custom-class根节点样式类

Sidebar 侧边导航 - 图1