Skip to content

TIP

🚧 组件库更新通知 🚧:我们正在努力完善我们的组件库。

MessageBox 消息弹框

模拟系统的消息提示框而实现的一套模态对话框组件,用于消息提示、确认消息和提交内容。

TIP

从设计上来说,MessageBox 的作用是美化系统自带的 alert、confirm 和 prompt,因此适合展示较为简单的内容。

消息提示

调用 kawaMessageBox.alert 方法以打开 alert 框。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

确认消息

调用 kawaMessageBox.confirm 方法以打开 confirm 框。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

提交内容

调用 kawaMessageBox.prompt 方法以打开 prompt 框。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

使用 VNode

message 可以是 VNode。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

个性化

可以通过配置 kawaMessageBox 的参数来实现一些个性化需求(options 参数见下文)。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

内容居中

消息弹框支持使用居中布局。

center 参数为 true 时,消息弹框内容会居中。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

全局方法

kawaMessageBox 提供了全局方法 kawaMessageBox.alertkawaMessageBox.confirmkawaMessageBox.prompt,用于在需要时弹出消息弹框。 如果完整引入了 kawaUI, 则会为 app.config.globalProperties 添加全局方法 $msgbox$alert$confirm$prompt。 在 Vue 实例中可以作为 this.$msgboxthis.$alertthis.$confirmthis.$prompt 使用。

单独引用

typescript
import { kawaMessageBox } from "kawa-ui";

MessageBox API

Options

NameDescriptionTypeDefault
titleMessageBox 标题string--
messageMessageBox 消息正文内容string | VNode | () => VNode--
typeMessageBox 类型,用于图标展示enum - 'success' | 'warning' | 'info' | 'error' |'danger'--
iconMessageBox 图标string--
callbackMessageBox 关闭回调函数(action: MessageBoxAction) => void--
show-close是否显示关闭按钮booleantrue
before-close关闭前的回调函数,会暂停 MessageBox 的关闭(action: MessageBoxAction,instance:MessageBoxOptions,done:()=>void) => void--
show-confirm-button是否显示确认按钮booleantrue
show-cancel-button是否显示取消按钮booleanfalse
confirm-button-text确认按钮的文字stringOK
cancel-button-text取消按钮的文字stringCancel
confirm-button-type确认按钮的类型stringprimary
cancel-button-type取消按钮的类型string--
confirm-button-disabled是否禁用确认按钮booleanfalse
confirm-button-loading是否显示确认按钮的加载状态booleanfalse
cancel-button-disabled是否禁用取消按钮booleanfalse
cancel-button-loading是否显示取消按钮的加载状态booleanfalse
close-on-click-modal点击遮罩是否允许关闭booleantrue
show-input是否显示输入框booleanfalse
input-placeholder输入框的提示文字stringPlace input...
input-type输入框的类型stringtext
input-value输入框的初始值string''
center是否居中显示booleanfalse
round-button是否显示圆角按钮booleanfalse
button-size按钮大小,可选值为 default、large 、smallstringdefault