0.0.1-alpha.1 • Published 1 month ago

@doraemon-ui/miniprogram.dialog v0.0.1-alpha.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 month ago

Dialog 对话框

模态对话框,在浮层中显示,引导用户进行相关操作。

使用指南

在 page.json 中引入组件

json

示例代码

在开发者工具中预览效果

WXML

wxml

JAVASCRIPT

js

WXSS

wxss

API

Dialog props

参数类型描述默认值
prefixClsstring自定义类名前缀dora-dialog
bodyStyleobject弹窗对应的自定义样式-
imagestring图片-
titlestring提示标题-
contentstring提示文本-
buttonClosableboolean点击操作按钮后后是否关闭false
verticalButtonsboolean是否显示垂直按钮布局false
closableboolean是否显示关闭按钮false
maskboolean是否显示蒙层true
maskClosableboolean点击蒙层是否允许关闭true
visibleboolean是否可见false
zIndexnumber设置蒙层的 z-index1000
buttonsarray操作按钮列表,更多参数见下 Button props[]
bind:closefunction点击关闭按钮或蒙层的回调函数-
bind:closedfunction关闭后的回调函数-

Button props

参数类型描述默认值
textstring按钮的文本-
typestring按钮的类型,可选值为 light、stable、positive、calm、assertive、balanced、energized、royal、darkdark
boldboolean是否加粗按钮的文字-
disabledboolean是否禁用false
openTypestring微信开放能力,可选值为 contact、share、getUserInfo、getPhoneNumber、launchApp、openSetting、feedback-
hoverClassstring指定按下去的样式类。当 hover-class="none" 时,没有点击态效果default
hoverStopPropagationboolean指定是否阻止本节点的祖先节点出现点击态false
hoverStartTimenumber按住后多久出现点击态,单位毫秒20
hoverStayTimenumber手指松开后点击态保留时间,单位毫秒70
langstring指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文。en
sessionFromstring会话来源-
sendMessageTitlestring会话内消息卡片标题当前标题
sendMessagePathstring会话内消息卡片点击跳转小程序路径当前分享路径
sendMessageImgstring会话内消息卡片图片截图
showMessageCardboolean显示会话内消息卡片false
appParameterstring打开 APP 时,向 APP 传递的参数-
onClickfunction按钮的点击事件-
onGetUserInfofunction用户点击该按钮时,会返回获取到的用户信息,回调的detail数据与wx.getUserInfo返回的一致-
onContactfunction客服消息回调-
onGotPhoneNumberfunction获取用户手机号回调-
onLaunchAppfunction打开 APP 成功的回调-
onErrorfunction当使用开放能力时,发生错误的回调-
onOpenSettingfunction在打开授权设置页后回调-

Dialog slot

名称描述
-自定义内容

Dialog externalClasses

名称描述
dora-class根节点样式类

Dialog.open

可以通过调用 Dialog 上的 open 方法直接打开对话框,其中 props 参数的类型同上表,但不支持传入 visible 属性。

当对话框被关闭后,组件实例会自动销毁。

此外,它还额外支持以下属性:

参数类型描述默认值
onClosefunction点击关闭按钮或蒙层的回调函数-
onClosedfunction关闭后的回调函数-

open 方法的调用后,会返回一个引用,可以通过该引用手动关闭对话框

const hideDialog = Dialog.open()
hideDialog()

Dialog.alert

alert 接受的参数同 open,但不支持 buttonClosable buttons 属性,它的返回值不是一个控制器对象,而是 Promise<void>

此外,它还额外支持以下属性:

参数类型描述默认值
confirmTextstring确定按钮的文字确定
confirmTypestring确定按钮的类型,可选值为 light、stable、positive、calm、assertive、balanced、energized、royal、darkbalanced
onConfirmfunction确定按钮的点击事件-

Dialog.confirm

confirm 接受的参数同 open,但不支持 buttonClosable buttons 属性,它的返回值不是一个控制器对象,而是 Promise<boolean>

此外,它还额外支持以下属性:

参数类型描述默认值
confirmTextstring确定按钮的文字确定
confirmTypestring确定按钮的类型,可选值为 light、stable、positive、calm、assertive、balanced、energized、royal、darkbalanced
onConfirmfunction确定按钮的点击事件-
cancelTextstring取消按钮的文字取消
cancelTypestring取消按钮的类型,可选值为 light、stable、positive、calm、assertive、balanced、energized、royal、darkdark
onCancelfunction取消按钮的点击事件-