[new feature] Sidebar: support use v-model to bind active key (#3698)

This commit is contained in:
neverland
2019-06-30 09:43:54 +08:00
committed by GitHub
parent 531fa6681e
commit a7b4b4c219
6 changed files with 55 additions and 54 deletions
+16 -15
View File
@@ -13,14 +13,11 @@ Vue.use(SidebarItem);
### Basic Usage
Use `active-key` prop to set index of chosen item
```html
<van-sidebar :active-key="activeKey" @change="onChange">
<van-sidebar v-model="activeKey">
<van-sidebar-item title="Title" />
<van-sidebar-item title="Title" />
<van-sidebar-item title="Title" />
<van-sidebar-item title="Title" info="8" />
<van-sidebar-item title="Title" info="99" />
<van-sidebar-item title="Title" info="99+" />
</van-sidebar>
```
@@ -30,29 +27,33 @@ export default {
return {
activeKey: 0
};
},
methods: {
onChange(key) {
this.activeKey = key;
}
}
};
```
### 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 |
|------|------|------|------|
| active-key | Index of chosen item | `String | Number` | `0` |
| v-model | Index of chosen item | `String | Number` | `0` |
### Sidebar Events
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when item changed | key: index of current item |
| change | Triggered when item changed | index: index of current item |
### SidebarItem Props
@@ -66,4 +67,4 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click item | key: index of current item |
| click | Triggered when click item | index: index of current item |