alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/tabbar/README.md
+43 -48
View File
@@ -27,10 +27,10 @@ Vue.use(TabbarItem);
export default {
data() {
return {
active: 0
}
}
}
active: 0,
};
},
};
```
### Match by name
@@ -48,10 +48,10 @@ export default {
export default {
data() {
return {
active: 'home'
}
}
}
active: 'home',
};
},
};
```
### Show Badge
@@ -73,9 +73,9 @@ Use `icon` slot to custom icon
<van-tabbar v-model="active">
<van-tabbar-item badge="3">
<span>Custom</span>
<template #icon="props">
<img :src="props.active ? icon.active : icon.inactive"/>
</template>
<template #icon="props">
<img :src="props.active ? icon.active : icon.inactive" />
</template>
</van-tabbar-item>
<van-tabbar-item icon="search">Tab</van-tabbar-item>
<van-tabbar-item icon="setting-o">Tab</van-tabbar-item>
@@ -89,21 +89,17 @@ export default {
active: 0,
icon: {
active: 'https://img.yzcdn.cn/vant/user-active.png',
inactive: 'https://img.yzcdn.cn/vant/user-inactive.png'
}
}
}
}
inactive: 'https://img.yzcdn.cn/vant/user-inactive.png',
},
};
},
};
```
### Custom Color
```html
<van-tabbar
v-model="active"
active-color="#07c160"
inactive-color="#000"
>
<van-tabbar v-model="active" active-color="#07c160" inactive-color="#000">
<van-tabbar-item icon="home-o">Tab</van-tabbar-item>
<van-tabbar-item icon="search">Tab</van-tabbar-item>
<van-tabbar-item icon="freinds-o">Tab</van-tabbar-item>
@@ -111,7 +107,6 @@ export default {
</van-tabbar>
```
### Change Event
```html
@@ -130,9 +125,9 @@ export default {
methods: {
onChange(index) {
Notify({ type: 'primary', message: index });
}
}
}
},
},
};
```
### Route Mode
@@ -155,38 +150,38 @@ export default {
### Tabbar Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Identifier of current tab | *number \| string* | `0` |
| fixed | Whether to fixed bottom | *boolean* | `true` |
| border | Whether to show border | *boolean* | `true` |
| z-index | Z-index | *number \| string* | `1` |
| active-color | Color of active tab item | *string* | `#1989fa` |
| inactive-color | Color of inactive tab item | *string* | `#7d7e80` |
| route | Whether to enable route mode | *boolean* | `false` |
| placeholder `v2.6.0` | Whether to generage a placeholder element when fixed | *boolean* | `false` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` |
| --- | --- | --- | --- |
| v-model | Identifier of current tab | _number \| string_ | `0` |
| fixed | Whether to fixed bottom | _boolean_ | `true` |
| border | Whether to show border | _boolean_ | `true` |
| z-index | Z-index | _number \| string_ | `1` |
| active-color | Color of active tab item | _string_ | `#1989fa` |
| inactive-color | Color of inactive tab item | _string_ | `#7d7e80` |
| route | Whether to enable route mode | _boolean_ | `false` |
| placeholder `v2.6.0` | Whether to generage a placeholder element when fixed | _boolean_ | `false` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` |
### Tabbar Events
| Event | Description | Arguments |
|------|------|------|
| Event | Description | Arguments |
| ------ | -------------------------------- | ---------------------------- |
| change | Triggered when change active tab | active: index of current tab |
### TabbarItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Identifier | *number \| string* | Item index |
| icon | Icon name | *string* | - |
| icon-prefix `v2.5.3` | Icon className prefix | *string* | `van-icon` |
| dot | Whether to show red dot | *boolean* | - |
| badge `v2.5.6` | Content of the badge | *number \| string* | `''` |
| 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` |
| --- | --- | --- | --- |
| name | Identifier | _number \| string_ | Item index |
| icon | Icon name | _string_ | - |
| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` |
| dot | Whether to show red dot | _boolean_ | - |
| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` |
| 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` |
### TabbarItem Slots
| Name | Description | SlotProps |
|------|------|------|
| icon | Custom icon | active |
| ---- | ----------- | --------- |
| icon | Custom icon | active |