mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-09 22:59:16 +08:00
74 lines
1.6 KiB
Markdown
74 lines
1.6 KiB
Markdown
# Sidebar
|
|
|
|
### Install
|
|
|
|
``` javascript
|
|
import Vue from 'vue';
|
|
import { Sidebar, SidebarItem } from 'vant';
|
|
|
|
Vue.use(Sidebar);
|
|
Vue.use(SidebarItem);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="Title" />
|
|
<van-sidebar-item title="Title" />
|
|
<van-sidebar-item title="Title" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
``` javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeKey: 0
|
|
};
|
|
}
|
|
};
|
|
```
|
|
|
|
### Show Badge
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="Title" info="8" />
|
|
<van-sidebar-item title="Title" info="99" />
|
|
<van-sidebar-item title="Title" info="99+" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
## API
|
|
|
|
### Sidebar Props
|
|
|
|
| Attribute | Description | Type | Default | Version |
|
|
|------|------|------|------|------|
|
|
| v-model | Index of chosen item | `string | number` | `0` | - |
|
|
|
|
### Sidebar Events
|
|
|
|
| Event | Description | Arguments |
|
|
|------|------|------|
|
|
| change | Triggered when item changed | index: index of current item |
|
|
|
|
### SidebarItem Props
|
|
|
|
| Attribute | Description | Type | Default | Version |
|
|
|------|------|------|------|------|
|
|
| title | Content | `string` | `''` | - |
|
|
| info | Info Message | `string | number` | `''` | - |
|
|
| url | Link | `string` | - | - |
|
|
| to | Target route of the link, same as to of vue-router | `string | object` | - | 2.0.4 |
|
|
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | 2.0.4 |
|
|
|
|
### SidebarItem Events
|
|
|
|
| Event | Description | Arguments |
|
|
|------|------|------|
|
|
| click | Triggered when click item | index: index of current item |
|