mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
163 lines
4.5 KiB
Markdown
163 lines
4.5 KiB
Markdown
## Dialog 弹出框
|
||
|
||
Dialog 组件支持函数调用和组件调用两种形式
|
||
|
||
### 使用指南
|
||
|
||
在 index.json 中引入组件
|
||
```json
|
||
"usingComponents": {
|
||
"van-dialog": "path/to/vant-weapp/dist/dialog/index"
|
||
}
|
||
```
|
||
|
||
### 代码演示
|
||
|
||
#### 消息提示
|
||
|
||
用于提示一些消息，只包含一个确认按钮
|
||
|
||
```html
|
||
<van-dialog id="van-dialog" />
|
||
```
|
||
|
||
```javascript
|
||
import Dialog from 'path/to/vant-weapp/dist/dialog/dialog';
|
||
|
||
Dialog.alert({
|
||
title: '标题',
|
||
message: '弹窗内容'
|
||
}).then(() => {
|
||
// on close
|
||
});
|
||
|
||
Dialog.alert({
|
||
message: '弹窗内容'
|
||
}).then(() => {
|
||
// on close
|
||
});
|
||
```
|
||
|
||
#### 消息确认
|
||
用于确认消息，包含取消和确认按钮
|
||
|
||
```javascript
|
||
Dialog.confirm({
|
||
title: '标题',
|
||
message: '弹窗内容'
|
||
}).then(() => {
|
||
// on confirm
|
||
}).catch(() => {
|
||
// on cancel
|
||
});
|
||
```
|
||
|
||
#### 高级用法
|
||
|
||
通过组件调用 Dialog 时，可以实现自定义弹窗内容、异步关闭等高级特性，具体可以参考下面的示例
|
||
|
||
```html
|
||
<van-dialog
|
||
use-slot
|
||
async-close
|
||
show="{{ show }}"
|
||
show-cancel-button
|
||
bind:close="onClose"
|
||
>
|
||
<van-field
|
||
value="{{ username }}"
|
||
label="用户名"
|
||
placeholder="请输入用户名"
|
||
/>
|
||
<van-field
|
||
value="{{ password }}"
|
||
type="password"
|
||
label="密码"
|
||
:border="false"
|
||
placeholder="请输入密码"
|
||
/>
|
||
</van-dialog>
|
||
```
|
||
|
||
```js
|
||
Page({
|
||
data: {
|
||
show: true,
|
||
username: '',
|
||
password: ''
|
||
},
|
||
|
||
onClose(event) {
|
||
if (event.detail === 'confirm') {
|
||
// 异步关闭弹窗
|
||
setTimeout(() => {
|
||
this.setData({
|
||
show: false
|
||
});
|
||
}, 1000);
|
||
} else {
|
||
this.setData({
|
||
show: false
|
||
});
|
||
}
|
||
}
|
||
});
|
||
```
|
||
|
||
|
||
### 方法
|
||
|
||
| 方法名 | 参数 | 返回值 | 介绍 |
|
||
|-----------|-----------|-----------|-------------|
|
||
| Dialog | `options` | `Promise` | 展示弹窗 |
|
||
| Dialog.alert | `options` | `Promise` | 展示消息提示弹窗 |
|
||
| Dialog.confirm | `options` | `Promise` | 展示消息确认弹窗 |
|
||
| Dialog.setDefaultOptions | `options` | `void` | 修改默认配置，对所有 Dialog 生效 |
|
||
| Dialog.resetDefaultOptions | - | `void` | 重置默认配置，对所有 Dialog 生效 |
|
||
| Dialog.close | - | `void` | 关闭弹窗 |
|
||
|
||
### Options
|
||
|
||
通过函数调用 Dialog 时，支持传入以下选项：
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
|-----------|-----------|-----------|-------------|
|
||
| title | 标题 | `String` | - |
|
||
| message | 内容 | `String` | - |
|
||
| selector | 自定义选择器 | `String` | `van-dialog` |
|
||
| showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` |
|
||
| showCancelButton | 是否展示取消按钮 | `Boolean` | `false` |
|
||
| confirmButtonText | 确认按钮的文案 | `String` | `确认` |
|
||
| cancelButtonText | 取消按钮的文案 | `String` | `取消` |
|
||
| confirmButtonOpenType | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | `String` | - |
|
||
| overlay | 是否展示蒙层 | `Boolean` | `true` |
|
||
| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` |
|
||
| asyncClose | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | `Boolean` | `false` |
|
||
|
||
### API
|
||
|
||
通过组件调用 Dialog 时，支持以下 API：
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
|-----------|-----------|-----------|-------------|
|
||
| show | 是否显示弹窗 | `Boolean` | - |
|
||
| title | 标题 | `String` | - |
|
||
| message | 内容 | `String` | - |
|
||
| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` |
|
||
| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` |
|
||
| confirm-button-text | 确认按钮的文案 | `String` | `确认` |
|
||
| cancel-button-text | 取消按钮的文案 | `String` | `取消` |
|
||
| confirm-button-open-type | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | `String` | - |
|
||
| overlay | 是否展示蒙层 | `Boolean` | `true` |
|
||
| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` |
|
||
| use-slot | 是否使用自定义内容的插槽 | `Boolean` | `false` |
|
||
| async-close | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | `Boolean` | `false` |
|
||
|
||
### Event
|
||
|
||
| 事件 | 说明 | 回调参数 |
|
||
|-----------|-----------|-----------|
|
||
| bind:close | 弹窗关闭时触发 | event.detail: 触发关闭事件的来源，枚举为`confirm`,`cancel`,`overlay` |
|
||
| bind:confirm | 点击确认按钮时触发 | - |
|
||
| bind:cancel | 点击取消按钮时触发 | - |
|