water_xcx/miniprogram_npm/tdesign-miniprogram/dialog
Cc a25b49fd6d 初始化:小程序同步 2025-04-15 15:44:51 +08:00
..
README.md 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.d.ts 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.js 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.json 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.wxml 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.wxs 初始化:小程序同步 2025-04-15 15:44:51 +08:00
dialog.wxss 初始化:小程序同步 2025-04-15 15:44:51 +08:00
index.d.ts 初始化:小程序同步 2025-04-15 15:44:51 +08:00
index.js 初始化:小程序同步 2025-04-15 15:44:51 +08:00
props.d.ts 初始化:小程序同步 2025-04-15 15:44:51 +08:00
props.js 初始化:小程序同步 2025-04-15 15:44:51 +08:00
type.d.ts 初始化:小程序同步 2025-04-15 15:44:51 +08:00
type.js 初始化:小程序同步 2025-04-15 15:44:51 +08:00

README.md

title description spline isComponent
Dialog 对话框 用于显示重要提示或请求用户进行重要操作,一种打断当前操作的模态视图。 message true

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-dialog": "tdesign-miniprogram/dialog/dialog"
}

代码演示

反馈类对话框

{{ base }}

使用这种方式,对话框的 visible 是受控的,需要手动设置额 visiblefalse 才会关闭对话框。

确认类对话框

{{ confirm }}

输入类对话框

{{ inputDialog }}

命令调用

{{ command }}

开发能力按钮

当传入的按钮类型为对象时,整个对象都将透传至 t-button,因此按钮可以直接使用开放能力

{{ button }}

API

Dialog Props

名称 类型 默认值 说明 必传
actions Array / Slot - 操作栏。TS 类型:Array<ButtonProps>Button API Documents详细类型定义 N
button-layout String horizontal 多按钮排列方式。可选项horizontal/vertical N
cancel-btn String / Object / Slot '' 取消按钮,可自定义。值为 null 则不显示取消按钮。值类型为字符串,则表示自定义按钮文本,值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时,需自行控制取消事件。详细类型定义 N
close-on-overlay-click Boolean true 点击蒙层时是否触发关闭事件 N
confirm-btn String / Object / Slot '' 确认按钮。值为 null 则不显示确认按钮。值类型为字符串,则表示自定义按钮文本,值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时,需自行控制确认事件 N
content String / Slot - 内容 N
external-classes Array - 组件类名,分别用于设置 组件外层元素、组件内容部分、确认按钮、取消按钮 等元素类名。['t-class', 't-class-content', 't-class-confirm', 't-class-cancel'] N
overlay-props Object {} 透传至 Overlay 组件 N
prevent-scroll-through Boolean true 防止滚动穿透 N
show-overlay Boolean true 是否显示遮罩层 N
title String / Slot - 标题 N
visible Boolean false 控制对话框是否显示 N
z-index Number 11500 组件层级,样式默认为 11500 N

Dialog Events

名称 参数 描述
cancel - 如果“取消”按钮存在,则点击“取消”按钮时触发,同时触发关闭事件
close (trigger: DialogEventSource) 关闭事件,点击 取消按钮 或 点击蒙层 时触发。详细类型定义
`type DialogEventSource = 'cancel'
overlay-click - 如果蒙层存在,点击蒙层时触发
confirm - 如果“确认”按钮存在,则点击“确认”按钮时触发
action (index: number) 操作列表的点击时间,index 代表操作列表的顺序
open-type-event (ButtonEventDetail) “确认”按钮具有开放能力的话,对应的成功回调
open-type-error-event (ButtonError) “确认”按钮具有开放能力的话,对应的失败回调