mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-11 07:29:16 +08:00
119 lines
2.5 KiB
Markdown
119 lines
2.5 KiB
Markdown
# Sidebar
|
|
|
|
### Install
|
|
|
|
```js
|
|
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>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeKey: 0,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### Show Badge
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="Title" dot />
|
|
<van-sidebar-item title="Title" badge="5" />
|
|
<van-sidebar-item title="Title" badge="99+" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
### Disabled
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey">
|
|
<van-sidebar-item title="Title" />
|
|
<van-sidebar-item title="Title" disabled />
|
|
<van-sidebar-item title="Title" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
### Change Event
|
|
|
|
```html
|
|
<van-sidebar v-model="activeKey" @change="onChange">
|
|
<van-sidebar-item title="Title1" />
|
|
<van-sidebar-item title="Title2" />
|
|
<van-sidebar-item title="Title3" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
```js
|
|
import { Notify } from 'vant';
|
|
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeKey: 0,
|
|
};
|
|
},
|
|
methods: {
|
|
onChange(index) {
|
|
Notify({ type: 'primary', message: index });
|
|
},
|
|
},
|
|
};
|
|
```
|
|
|
|
## API
|
|
|
|
### Sidebar Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --------- | -------------------- | ------------------ | ------- |
|
|
| v-model | Index of chosen item | _number \| string_ | `0` |
|
|
|
|
### Sidebar Events
|
|
|
|
| Event | Description | Arguments |
|
|
| ------ | --------------------------- | ---------------------------- |
|
|
| change | Triggered when item changed | index: index of current item |
|
|
|
|
### SidebarItem Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| title | Content | _string_ | `''` |
|
|
| dot | Whether to show red dot | _boolean_ | `false` |
|
|
| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` |
|
|
| disabled | Whether to be disabled | _boolean_ | `false` |
|
|
| url | Link | _string_ | - |
|
|
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
|
|
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |
|
|
|
|
### SidebarItem Events
|
|
|
|
| Event | Description | Arguments |
|
|
| ----- | ------------------------- | ---------------------------- |
|
|
| click | Triggered when click item | index: index of current item |
|
|
|
|
### SidebarItem Slots
|
|
|
|
| Name | Description |
|
|
| ----- | ---------------- |
|
|
| title | Custom item title |
|