mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-18 02:39:14 +08:00
122 lines
3.0 KiB
Markdown
122 lines
3.0 KiB
Markdown
# Sidebar 侧边导航
|
|
|
|
### 引入
|
|
|
|
```js
|
|
import Vue from 'vue';
|
|
import { Sidebar, SidebarItem } from 'vant';
|
|
|
|
Vue.use(Sidebar);
|
|
Vue.use(SidebarItem);
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
通过`v-model`绑定当前选中项的索引
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="标签名称" />
|
|
<van-sidebar-item title="标签名称" />
|
|
<van-sidebar-item title="标签名称" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeKey: 0,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### 徽标提示
|
|
|
|
设置`dot`属性后，会在右上角展示一个小红点。设置`badge`属性后，会在右上角展示相应的徽标
|
|
|
|
```html
|
|
<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`属性禁用选项
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="标签名称" />
|
|
<van-sidebar-item title="标签名称" disabled />
|
|
<van-sidebar-item title="标签名称" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
### 监听切换事件
|
|
|
|
设置`change`方法来监听切换导航项时的事件
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey" @change="onChange">
|
|
<van-sidebar-item title="标签名1" />
|
|
<van-sidebar-item title="标签名2" />
|
|
<van-sidebar-item title="标签名3" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
```js
|
|
import { Notify } from 'vant';
|
|
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeKey: 0,
|
|
};
|
|
},
|
|
methods: {
|
|
onChange(index) {
|
|
Notify({ type: 'primary', message: index });
|
|
},
|
|
},
|
|
};
|
|
```
|
|
|
|
## API
|
|
|
|
### Sidebar Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| ---------------- | ---------------- | ------------------ | ------ |
|
|
| v-model `v2.0.4` | 当前导航项的索引 | _number \| string_ | `0` |
|
|
|
|
### Sidebar Events
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
| ------ | ---------------- | ----------------------- |
|
|
| change | 切换导航项时触发 | index: 当前导航项的索引 |
|
|
|
|
### SidebarItem Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| title | 内容 | _string_ | `''` |
|
|
| dot `v2.2.1` | 是否显示右上角小红点 | _boolean_ | `false` |
|
|
| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - |
|
|
| info | 图标右上角徽标的内容（已废弃，请使用 badge 属性） | _number \| string_ | - |
|
|
| disabled `v2.2.0` | 是否禁用该项 | _boolean_ | `false` |
|
|
| url | 点击后跳转的链接地址 | _string_ | - |
|
|
| to `v2.0.4` | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
|
|
| replace `v2.0.4` | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |
|
|
|
|
### SidebarItem Events
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
| ------ | ---------- | ----------------------- |
|
|
| click | 点击时触发 | index: 当前导航项的索引 |
|