Dialog 对话框
优质
小牛编辑
127浏览
2023-12-01
使用指南
组件介绍
弹出模态框,常用于消息提示、消息确认、在当前页面内完成特定的交互操作。
函数调用
Dialog 是一个函数而不是组件,因此可以直接调用,展示对应的提示弹窗
import { Dialog } from 'feart';
Dialog({ message: '提示' });
组件调用
通过组件调用 Dialog 时,可以通过下面的方式进行注册
import { Dialog } from 'feart';
export default {
components: {
'fe-dialog': Dialog.Component,
},
};
代码演示
消息提示
用于提示一些消息,只包含一个确认按钮
Dialog.alert({
title: '标题',
message: '弹窗内容',
}).then(() => {
// on close
});
Dialog.alert({
message: '弹窗内容',
}).then(() => {
// on close
});
消息确认
用于确认消息,包含取消和确认按钮
Dialog.confirm({
title: '标题',
message: '弹窗内容',
})
.then(() => {
// on confirm
})
.catch(() => {
// on cancel
});
文本输入确认弹窗
用于确认消息,包含取消和确认按钮,res 为输入框返回值
Dialog.prompt({
title: '标题',
message: '弹窗内容',
})
.then((res) => {
// on confirm
})
.catch((res) => {
// on cancel
});
运营活动弹窗
用于运营活动图片展示
Dialog.activity({
imgUrl: ... // imgUrl
}).then(() => {
// on confirm
})
异步关闭
function beforeClose(action, done) {
if (action === 'confirm') {
setTimeout(done, 1000);
} else {
done();
}
}
Dialog.confirm({
title: '标题',
message: '弹窗内容',
beforeClose,
});
全局方法
引入 Dialog 组件后,会自动在 Vue 的 prototype 上挂载 $dialog 方法,在所有组件内部都可以直接调用此方法
export default {
mounted() {
this.$dialog.alert({
message: '弹窗内容',
});
},
};
组件调用
如果需要在弹窗内嵌入组件或其他自定义内容,可以使用组件调用的方式.
<fe-dialog
showCancelButton
:visible="this.visible"
title="标题"
@onConfirm="onConfirm('onConfirm')"
>
<div>Dialog 对话框</div>
</fe-dialog>
export default {
data() {
return {
visible: true,
};
},
methods: {
onConfirm(str) {
console.log(str);
this.visible = false;
},
},
};
API
方法
方法名 | 参数 | 返回值 | 介绍 |
---|---|---|---|
Dialog | options | Promise | 展示弹窗 |
Dialog.alert | options | Promise | 展示消息提示弹窗 |
Dialog.confirm | options | Promise | 展示消息确认弹窗 |
Dialog.prompt | options | Promise | 文本输入确认弹窗 |
Dialog.img | options | Promise | 带图片展示消息提示弹窗 |
Dialog.icon | options | Promise | 带 icon 消息提示弹窗 |
Dialog.activity | options | Promise | 活动展示框 |
Dialog.setDefaultOptions | options | void | 修改默认配置,对所有 Dialog 生效 |
Dialog.resetDefaultOptions | - | void | 重置默认配置,对所有 Dialog 生效 |
Dialog.close | - | void | 关闭弹窗 |
- | - | - | - |
Options
通过函数调用 Dialog
时,支持传入以下通用选项(Dialog.activity 不通用):
参数 | 说明 | 类型 | 默认值 | 可选值 |
---|---|---|---|---|
title | 标题 | String | - | - |
message | 文本内容,支持通过\n 换行 | String | - | - |
messageAlign | 内容对齐方式,可选值为 left center right | String | center | - |
className | 自定义类名 | String Array | Object | - |
showConfirmButton | 是否展示确认按钮 | Boolean | true | - |
showCancelButton | 是否展示取消按钮 | Boolean | false | - |
cancelButtonText | 取消按钮文案 | String | 取消 | - |
confirmButtonText | 确认按钮文案 | String | 确认 | - |
overlay | 是否展示遮罩层 | Boolean | true | - |
closeOnClickOverlay | 点击遮罩层时是否关闭弹窗 | Boolean | false | - |
beforeClose | 关闭前的回调函数, 调用 done() 后关闭弹窗,调用 done(false) 阻止弹窗关闭 | (action, done) => void | - | - |
- | - | - | - | - |
通过函数调用 Dialog.prompt
时,支持传入以下独立选项:
参数 | 说明 | 类型 | 默认值 | 可选值 |
---|---|---|---|---|
placeholder | 提示文案 | String | - | - |
inputValue | 文本内容 | String | - | - |
maxlength | 输入字段的最大长度,以字符个数计 | Number | 20 | - |
- | - | - | - | - |
通过函数调用 Dialog.img
时,支持传入以下独立选项:
参数 | 说明 | 类型 | 默认值 | 可选值 |
---|---|---|---|---|
imgUrl | 展示图片,可以直接传图片地址,也可以 dom 节点(eg: icon 节点) | String | - | - |
imgsize | 尺寸,可选值为 default overspread default :根据图片大小决定overspread :100%平铺 | String | default | - |
showClose | 关闭按钮 | Boolean | true | - |
- | - | - | - | - |
通过函数调用 Dialog.icon
时,支持传入以下独立选项:
参数 | 说明 | 类型 | 默认值 | 可选值 |
---|---|---|---|---|
iconType | icon 类型,可选值为 success error warning | String | success | - |
- | - | - | - | - |
通过函数调用 Dialog.activity
时,仅支持传入以下选项(不可使用 Dialog 通用参数选项):
参数 | 说明 | 类型 | 默认值 | 可选值 |
---|---|---|---|---|
imgUrl | 展示图片,目前仅支持传图片地址 | String | - | - |
size | 尺寸,可选值为default large | String | default | - |
className | 自定义类名 | String Array | Object | - |
overlay | 是否展示遮罩层 | Boolean | true | - |
closeOnClickOverlay | 点击遮罩层时是否关闭弹窗 | Boolean | false | - |
beforeClose | 关闭前的回调函数, 调用 done() 后关闭弹窗, 调用 done(false) 阻止弹窗关闭 | (action, done) => void | - | - |
- | - | - | - | - |
Props
通过组件调用 Dialog
时,支持以下 Props:
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
visible | 是否显示弹窗 | Boolean | - | - |
title | 标题 | String | - | - |
showCancelButton | 是否展示取消按钮 | Boolean | false | - |
confirmButtonText | 确认按钮文案 | String | 确认 | - |
cancelButtonText | 取消按钮文案 | String | 取消 | - |
overlay | 是否展示遮罩层 | Boolean | true | - |
Slots
通过组件调用 Dialog
时,支持以下 Slots
Slot 名 | 说明 | 备注 |
---|---|---|
default | 内容插槽 | - |
- | - | - |
Events
通过组件调用 Dialog
时,支持以下 Events。 使用方式:@onConfirm="onConfirm('onConfirm')"
参数 | 说明 |
---|---|
onConfirm | 点击确认按钮,且按钮状态不为加载或禁用时触发 |
onCancel | 点击取消按钮,且按钮状态不为加载或禁用时触发 |