Vant3 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="active">
  <van-sidebar-item title="标签名称" />
  <van-sidebar-item title="标签名称" />
  <van-sidebar-item title="标签名称" />
</van-sidebar>
import { ref } from vue;

export default {
  setup() {
    const active = ref(0);
    return { active };
  },
};

徽标提示

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

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

禁用选项

通过 disabled 属性禁用选项。

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

监听切换事件

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

<van-sidebar v-model="active" @change="onChange">
  <van-sidebar-item title="标签名 1" />
  <van-sidebar-item title="标签名 2" />
  <van-sidebar-item title="标签名 3" />
</van-sidebar>
import { ref } from vue;
import { Toast } from vant;

export default {
  setup() {
    const active = ref(0);
    const onChange = (index) => Toast(`标签名 ${index + 1}`);
    return {
      active,
      onChange,
    };
  },
};

API

Sidebar Props

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

Sidebar Events

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

SidebarItem Props

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

SidebarItem Events

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

SidebarItem Slots

NameDescription
title自定义标题

样式变量

组件提供了下列 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-gray-5)
–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-white)

作者:andy,如若转载,请注明出处:https://www.web176.com/vant3/18686.html

(0)
打赏 支付宝 支付宝 微信 微信
andy的头像andy
上一篇 2023年4月28日
下一篇 2023年4月28日

相关推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注