mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
242 lines
7.1 KiB
Markdown
242 lines
7.1 KiB
Markdown
# DropdownMenu 下拉菜单
|
|
|
|
### 介绍
|
|
|
|
向下弹出的菜单列表。
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)。
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-dropdown-menu": "@vant/weapp/dropdown-menu/index",
|
|
"van-dropdown-item": "@vant/weapp/dropdown-item/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
```html
|
|
<van-dropdown-menu>
|
|
<van-dropdown-item value="{{ value1 }}" options="{{ option1 }}" />
|
|
<van-dropdown-item value="{{ value2 }}" options="{{ option2 }}" />
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
option1: [
|
|
{ text: '全部商品', value: 0 },
|
|
{ text: '新款商品', value: 1 },
|
|
{ text: '活动商品', value: 2 },
|
|
],
|
|
option2: [
|
|
{ text: '默认排序', value: 'a' },
|
|
{ text: '好评排序', value: 'b' },
|
|
{ text: '销量排序', value: 'c' },
|
|
],
|
|
value1: 0,
|
|
value2: 'a',
|
|
},
|
|
});
|
|
```
|
|
|
|
### 自定义菜单内容
|
|
|
|
```html
|
|
<van-dropdown-menu>
|
|
<van-dropdown-item value="{{ value1 }}" options="{{ option1 }}" />
|
|
<van-dropdown-item id="item" title="{{ itemTitle }}">
|
|
<van-cell title="{{ switchTitle1 }}">
|
|
<van-switch
|
|
slot="right-icon"
|
|
size="24px"
|
|
style="height: 26px"
|
|
checked="{{ switch1 }}"
|
|
active-color="#ee0a24"
|
|
bind:change="onSwitch1Change"
|
|
/>
|
|
</van-cell>
|
|
<van-cell title="{{ switchTitle2 }}">
|
|
<van-switch
|
|
slot="right-icon"
|
|
size="24px"
|
|
style="height: 26px"
|
|
checked="{{ switch2 }}"
|
|
active-color="#ee0a24"
|
|
bind:change="onSwitch2Change"
|
|
/>
|
|
</van-cell>
|
|
<view style="padding: 5px 16px;">
|
|
<van-button type="danger" block round bind:click="onConfirm">
|
|
确认
|
|
</van-button>
|
|
</view>
|
|
</van-dropdown-item>
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
switchTitle1: '包邮',
|
|
switchTitle2: '团购',
|
|
itemTitle: '筛选',
|
|
option1: [
|
|
{ text: '全部商品', value: 0 },
|
|
{ text: '新款商品', value: 1 },
|
|
{ text: '活动商品', value: 2 },
|
|
],
|
|
value1: 0,
|
|
},
|
|
|
|
onConfirm() {
|
|
this.selectComponent('#item').toggle();
|
|
},
|
|
|
|
onSwitch1Change({ detail }) {
|
|
this.setData({ switch1: detail });
|
|
},
|
|
|
|
onSwitch2Change({ detail }) {
|
|
this.setData({ switch2: detail });
|
|
},
|
|
});
|
|
```
|
|
|
|
### 自定义选中状态颜色
|
|
|
|
```html
|
|
<van-dropdown-menu active-color="#1989fa">
|
|
<van-dropdown-item value="{{ value1 }}" options="{{ option1 }}" />
|
|
<van-dropdown-item value="{{ value2 }}" options="{{ option2 }}" />
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
### 向上展开
|
|
|
|
```html
|
|
<van-dropdown-menu direction="up">
|
|
<van-dropdown-item value="{{ value1 }}" options="{{ option1 }}" />
|
|
<van-dropdown-item value="{{ value2 }}" options="{{ option2 }}" />
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
### 禁用菜单
|
|
|
|
```html
|
|
<van-dropdown-menu>
|
|
<van-dropdown-item value="{{ value1 }}" disabled options="{{ option1 }}" />
|
|
<van-dropdown-item value="{{ value2 }}" disabled options="{{ option2 }}" />
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
### 异步打开/关闭
|
|
|
|
通过 `before-toggle` 事件可以在下拉菜单打开或者关闭前执行特定的逻辑，实现状态变更前校验、异步打开/关闭的目的
|
|
|
|
```html
|
|
<van-dropdown-menu>
|
|
<van-dropdown-item value="{{ value1 }}" options="{{ option1 }}" use-before-toggle bind:before-toggle="onBeforeChange" />
|
|
</van-dropdown-menu>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
value1: 0,
|
|
option1: [
|
|
{ text: '全部商品', value: 0 },
|
|
{ text: '新款商品', value: 1 },
|
|
{ text: '活动商品', value: 2 },
|
|
],
|
|
},
|
|
onBeforeChange({ detail: { status, callback }}) {
|
|
wx.showModal({
|
|
title: '异步打开/关闭',
|
|
content: `确定要${status ? '打开' : '关闭'}下拉菜单吗？`,
|
|
success: (res) => {
|
|
if (res.confirm) {
|
|
callback(true)
|
|
} else if (res.cancel) {
|
|
callback(false)
|
|
}
|
|
},
|
|
})
|
|
}
|
|
});
|
|
```
|
|
|
|
## API
|
|
|
|
### DropdownMenu Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| active-color | 菜单标题和选项的选中态颜色 | _string_ | `#ee0a24` |
|
|
| z-index | 菜单栏 z-index 层级 | _number_ | `10` |
|
|
| duration | 动画时长，单位毫秒 | _number_ | `200` |
|
|
| direction | 菜单展开方向，可选值为 up | _string_ | `down` |
|
|
| overlay | 是否显示遮罩层 | _boolean_ | `true` |
|
|
| safe-area-tab-bar `v1.10.14`| 是否留出底部 tabbar 安全距离 | _boolean_ | `false` |
|
|
| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | _boolean_ | `true` |
|
|
| close-on-click-outside | 是否在点击外部 menu 后关闭菜单 | _boolean_ | `true` |
|
|
|
|
### DropdownItem Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| value | 当前选中项对应的 value | _number \| string_ | - |
|
|
| title | 菜单项标题 | _string_ | 当前选中项文字 |
|
|
| options | 选项数组 | _Option[]_ | `[]` |
|
|
| disabled | 是否禁用菜单 | _boolean_ | `false` |
|
|
| title-class | 标题额外类名，建议使用自定义样式 item-title-class 代替 | _string_ | - |
|
|
| popup-style | 自定义弹出层样式 | _string_ | - |
|
|
| use-before-toggle `v1.10.12` | 是否开启下拉菜单打开或者关闭前校验 | _boolean_ | `false` |
|
|
| root-portal `v1.10.14` | 是否从页面子树中脱离出来，用于解决各种 fixed 失效问题，微信基础库 >= `2.25.2 ` | _boolean_ | `false` |
|
|
|
|
### DropdownItem Events
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
| ------ | ----------------------------- | -------- |
|
|
| change | 点击选项导致 value 变化时触发 | value |
|
|
| open | 打开菜单栏时触发 | - |
|
|
| close | 关闭菜单栏时触发 | - |
|
|
| opened | 打开菜单栏且动画结束后触发 | - |
|
|
| closed | 关闭菜单栏且动画结束后触发 | - |
|
|
| before-toggle `v1.10.12` | 下拉菜单打开或者关闭前触发，需要将`use-before-toggle`属性设置为`true` | `event.detail.status`: `true` 打开下拉菜单，`false` 关闭下拉菜单 <br>`event.detail.callback`: 回调函数，调用`callback(false)`终止下拉菜单状态变更 |
|
|
|
|
### DropdownItem 方法
|
|
|
|
通过 selectComponent(id) 可访问。
|
|
|
|
| 方法名 | 说明 | 参数 | 返回值 |
|
|
| --- | --- | --- | --- |
|
|
| toggle | 切换菜单展示状态，传`true`为显示，`false`为隐藏，不传参为取反 | show?: boolean | - |
|
|
|
|
### Option 数据结构
|
|
|
|
| 键名 | 说明 | 类型 |
|
|
| ----- | -------------------------------- | ------------------ |
|
|
| text | 文字 | _string_ |
|
|
| value | 标识符 | _number \| string_ |
|
|
| icon | 左侧[图标名称](#/icon)或图片链接 | _string_ |
|
|
|
|
### DropdownMenu 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
| --------------------- | ------------ |
|
|
| custom-class | 根节点样式类 |
|
|
| title-class `v1.10.7` | 选中项样式类 |
|
|
|
|
### DropdownItem 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
| -------------------------- | ------------ |
|
|
| custom-class `v1.10.7` | 根节点样式类 |
|
|
| item-title-class `v1.10.7` | 选项样式类 |
|