mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
93 lines
2.0 KiB
Markdown
93 lines
2.0 KiB
Markdown
# Sidebar 侧边导航
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-sidebar": "path/to/vant-weapp/dist/sidebar/index",
|
|
"van-sidebar-item": "path/to/vant-weapp/dist/sidebar-item/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
通过在`van-sidebar`上设置`active`属性来控制选中项
|
|
|
|
```html
|
|
<van-sidebar active="{{ active }}" bind:change="onChange">
|
|
<van-sidebar-item title="标签名称" />
|
|
<van-sidebar-item title="标签名称" />
|
|
<van-sidebar-item title="标签名称" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
``` javascript
|
|
Page({
|
|
data: {
|
|
active: 0
|
|
},
|
|
|
|
onChange(event) {
|
|
wx.showToast({
|
|
icon: 'none',
|
|
title: `切换至第${event.detail}项`
|
|
});
|
|
}
|
|
});
|
|
```
|
|
|
|
### 显示徽标
|
|
|
|
通过`info`属性设置徽标内容
|
|
|
|
```html
|
|
<van-sidebar active="{{ active }}">
|
|
<van-sidebar-item title="标签名称" info="8" />
|
|
<van-sidebar-item title="标签名称" info="99" />
|
|
<van-sidebar-item title="标签名称" info="99+" />
|
|
</van-sidebar>
|
|
```
|
|
|
|
## API
|
|
|
|
### Sidebar API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| active | 选中项的索引 | *string \| number* | `0` | - |
|
|
|
|
### Sidebar Event
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
|------|------|------|
|
|
| change | 切换徽章时触发 | 当前选中徽章的索引 |
|
|
|
|
### Sidebar 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
|-----------|-----------|
|
|
| custom-class | 根节点样式类 |
|
|
|
|
### SidebarItem API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| title | 内容 | *string* | `''` | - |
|
|
| info | 提示消息 | *string \| number* | `''` | - |
|
|
|
|
### SidebarItem Event
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
|------|------|------|
|
|
| click | 点击徽章时触发 | 当前徽章的索引 |
|
|
|
|
### SidebarItem 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
|-----------|-----------|
|
|
| custom-class | 根节点样式类 |
|