mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
152 lines
4.0 KiB
Markdown
152 lines
4.0 KiB
Markdown
## Dialog 弹出框
|
|
Dialog 组件支持函数调用和组件调用两种形式
|
|
|
|
### 使用指南
|
|
|
|
```js
|
|
import { Dialog } from 'vant';
|
|
```
|
|
|
|
### 代码演示
|
|
|
|
#### 消息提示
|
|
用于提示一些消息，只包含一个确认按钮
|
|
|
|
```javascript
|
|
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 组件后，会自动在 Vue 的 prototype 上挂载 $dialog 方法，在所有组件内部都可以直接调用此方法
|
|
|
|
```js
|
|
export default {
|
|
mounted() {
|
|
this.$dialog.alert({
|
|
message: '弹窗内容'
|
|
});
|
|
}
|
|
}
|
|
```
|
|
|
|
### 方法
|
|
|
|
| 方法名 | 参数 | 返回值 | 介绍 |
|
|
|-----------|-----------|-----------|-------------|
|
|
| Dialog | `options` | `Promise` | 展示弹窗 |
|
|
| Dialog.alert | `options` | `Promise` | 展示消息提示弹窗 |
|
|
| Dialog.confirm | `options` | `Promise` | 展示消息确认弹窗 |
|
|
| Dialog.setDefaultOptions | `options` | `void` | 修改默认配置，对所有 Dialog 生效 |
|
|
| Dialog.resetDefaultOptions | - | `void` | 重置默认配置，对所有 Dialog 生效 |
|
|
| Dialog.close | - | `void` | 关闭弹窗 |
|
|
|
|
### Options
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| title | 标题 | `String` | - | - |
|
|
| message | 内容 | `String` | - | - |
|
|
| showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` | - |
|
|
| showCancelButton | 是否展示取消按钮 | `Boolean` | `false` | - |
|
|
| confirmButtonText | 确认按钮的文案 | `String` | `确认` | - |
|
|
| cancelButtonText | 取消按钮的文案 | `String` | `取消` | - |
|
|
| overlay | 是否展示蒙层 | `Boolean` | `true` | - |
|
|
| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - |
|
|
| lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | - |
|
|
| beforeClose | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - |
|
|
|
|
|
|
#### 高级用法
|
|
如果需要在弹窗内实现更复杂的交互，可以通过组件形式来调用 Dialog
|
|
|
|
```html
|
|
<van-dialog
|
|
v-model="show"
|
|
show-cancel-button
|
|
:before-close="beforeClose"
|
|
>
|
|
<van-field
|
|
v-model="username"
|
|
label="用户名"
|
|
placeholder="请输入用户名"
|
|
/>
|
|
<van-field
|
|
v-model="password"
|
|
type="password"
|
|
:label="密码"
|
|
:placeholder="请输入密码"
|
|
/>
|
|
</van-dialog>
|
|
```
|
|
|
|
```js
|
|
Vue.use(Dialog);
|
|
|
|
export default {
|
|
data() {
|
|
return {
|
|
show: false,
|
|
username: '',
|
|
password: ''
|
|
};
|
|
},
|
|
|
|
methods: {
|
|
beforeClose() {
|
|
if (action === 'confirm') {
|
|
setTimeout(done, 1000);
|
|
} else {
|
|
done();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| v-model | 是否显示弹窗 | `Boolean` | - | - |
|
|
| title | 标题 | `String` | - | - |
|
|
| message | 内容 | `String` | - | - |
|
|
| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` | - |
|
|
| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` | - |
|
|
| confirm-button-text | 确认按钮的文案 | `String` | `确认` | - |
|
|
| cancel-button-text | 取消按钮的文案 | `String` | `取消` | - |
|
|
| overlay | 是否展示蒙层 | `Boolean` | `true` | - |
|
|
| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - |
|
|
| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - |
|
|
| before-close | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - |
|
|
|
|
### Event
|
|
|
|
| 事件 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| confirm | 点击确认按钮时触发 | - |
|
|
| cancel | 点击取消按钮时触发 | - | |