amis/docs/zh-CN/components/dialog.md

886 lines
26 KiB
Markdown
Raw Normal View History

2020-07-28 10:03:53 +08:00
---
title: Dialog 对话框
2020-07-29 16:20:21 +08:00
description:
2020-07-28 10:03:53 +08:00
type: 0
group: ⚙ 组件
menuName: Dialog 对话框
2020-07-29 16:20:21 +08:00
icon:
2020-07-28 10:03:53 +08:00
order: 41
---
2020-07-29 16:20:21 +08:00
2020-07-28 10:03:53 +08:00
Dialog 弹框 主要由 [Action](./action) 触发,主要展示一个对话框以供用户操作。
## 基本用法
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"label": "点击弹框",
"type": "button",
"actionType": "dialog",
"dialog": {
"title": "弹框标题",
"body": "这是一个弹框"
}
}
```
## 配置尺寸
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button-toolbar",
"buttons": [
{
"type": "button",
"label": "较小的弹框",
"actionType": "dialog",
"dialog": {
"size": "sm",
"title": "提示",
"body": "这是个简单的弹框"
}
},
{
"type": "button",
"label": "标准弹框",
"actionType": "dialog",
"dialog": {
"title": "提示",
"body": "这是个简单的弹框"
}
},
{
"type": "button",
"label": "较大的弹框",
"actionType": "dialog",
"dialog": {
"size": "lg",
"title": "提示",
"body": "这是个简单的弹框"
}
},
{
"type": "button",
"label": "很大的弹框",
"actionType": "dialog",
"dialog": {
"size": "xl",
"title": "提示",
"body": "这是个简单的弹框"
}
},
{
"type": "button",
"label": "占满屏幕的弹框",
"actionType": "dialog",
"dialog": {
"size": "full",
"title": "全屏弹框",
"body": "弹框尽可能占满,内容部分滚动。"
}
}
]
}
```
2020-11-12 17:21:42 +08:00
## 弹框与数据映射
默认弹框内由于数据链的存在,会自动映射父级同名变量,例如下例:
```schema: scope="body"
2020-11-12 17:21:42 +08:00
{
"type": "crud",
"api": "/api/mock2/sample",
2020-11-12 17:21:42 +08:00
"draggable": true,
"columns": [
{
"name": "id",
"label": "ID"
},
{
"name": "engine",
"label": "Rendering engine"
},
{
"name": "browser",
"label": "Browser"
},
{
"name": "platform",
"label": "Platform(s)"
},
{
"name": "version",
"label": "Engine version"
},
{
"name": "grade",
"label": "CSS grade"
},
{
"type": "button",
"label": "一个弹框",
"actionType": "dialog",
"dialog": {
"title": "一个弹框",
"body": [
{
"type": "form",
"api": "/api/mock2/sample/$id",
"body": [
2020-11-12 17:21:42 +08:00
{
"type": "input-text",
2020-11-12 17:21:42 +08:00
"name": "engine",
"label": "Engine"
}
]
}
]
}
}
]
}
```
上例弹框中的表单项 `Engine` 会自动映射到父级数据中的 `engine` 变量,如果想调整当前特性,如你想调整父级映射变量的字段,可以利用[数据映射](../../docs/concepts/data-mapping),例如:
2020-11-12 17:21:42 +08:00
```schema: scope="body"
2020-11-12 17:21:42 +08:00
{
"type": "crud",
"api": "/api/mock2/sample",
2020-11-12 17:21:42 +08:00
"draggable": true,
"syncLocation": false,
"filter": {
"title": "过滤器",
"body": [
{
"type": "select",
"label": "状态",
"name": "status",
"options": [
{
"label": "运行中",
"value": "running"
},
{
"label": "创建中",
"value": "creating"
}
],
"checkAll": true,
"multiple": true,
"joinValues": true,
"defaultCheckAll": true,
"checkAllLabel": "全选",
"valuesNoWrap": false
}
]
},
"headerToolbar": [
{
"label": "新增",
"type": "button",
"actionType": "dialog",
"level": "primary",
"dialog": {
"type": "dialog",
"title": "新增",
"closeOnEsc": false,
"closeOnOutside": false,
"showCloseButton": true,
"data": {
"&": "\$\$",
"status": "__undefined"
},
"body": [
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"debug": true,
"body": [
{
"type": "select",
"name": "status",
"label": "状态",
"options": [
{
"label": "运行中",
"value": "running"
},
{
"label": "创建中",
"value": "creating"
}
],
"disabled": false,
"selectFirst": false
}
]
}
]
}
}
],
2020-11-12 17:21:42 +08:00
"columns": [
{
"name": "id",
"label": "ID"
},
{
"name": "engine",
"label": "Rendering engine"
},
{
"name": "browser",
"label": "Browser"
},
{
"name": "platform",
"label": "Platform(s)"
},
{
"name": "version",
"label": "Engine version"
},
{
"name": "grade",
"label": "CSS grade"
},
{
"type": "button",
"label": "一个弹框",
"actionType": "dialog",
"dialog": {
"data": {
"engine2": "${engine}"
},
"title": "一个弹框",
"body": [
{
"type": "form",
"api": "/api/mock2/sample/$id",
"body": [
2020-11-12 17:21:42 +08:00
{
"type": "input-text",
2020-11-12 17:21:42 +08:00
"name": "engine2",
"label": "Engine"
}
]
}
]
}
}
]
}
```
上例给 `dialog` 中配置 `data` 属性,可以将上层的 `engine` 变量映射为 `engine2`。请注意点击“新增”按钮后 dialog 内 form 的数据域会直接继承 CRUD 所在的数据域,如果 CRUD 过滤器中查询字段和 dialog 表单中的字段相同时,会错误的将外部数据映射到表单数据域内,需要配置数据映射将相关字段绑定的数据删除`{"&": "$$", "status": "__undefined"}`
2020-11-12 17:21:42 +08:00
2020-07-28 10:03:53 +08:00
## 多级弹框
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "多级弹框",
"actionType": "dialog",
"dialog": {
"title": "提示",
"body": "这是个简单的弹框",
"actions": [
{
"type": "button",
"actionType": "confirm",
"label": "确认",
"primary": true
},
{
"type": "button",
"actionType": "dialog",
"label": "再弹一个",
"dialog": {
"title": "弹框中的弹框",
"body": "如果你想,可以无限弹下去",
"actions": [
{
"type": "button",
"actionType": "dialog",
"label": "来吧",
"level": "info",
"dialog": {
"title": "弹框中的弹框",
"body": "如果你想,可以无限弹下去",
"actions": [
{
"type": "button",
"actionType": "confirm",
"label": "不弹了",
"primary": true
}
]
}
}
]
}
}
]
}
}
```
2020-08-26 15:25:09 +08:00
## 行为后关闭弹框
在弹框中配置行为按钮,可以在按钮上配置`"close": true`,在行为完成后,关闭当前弹框。
```schema: scope="body"
2020-08-26 15:25:09 +08:00
{
"type": "button",
"label": "弹个框",
"actionType": "dialog",
"dialog": {
"title": "弹框",
"body": [
{
2021-08-03 10:11:51 +08:00
"type": "button",
2020-08-26 15:25:09 +08:00
"label": "默认的 ajax 请求",
"actionType": "ajax",
"api": "/api/mock2/form/saveForm?waitSeconds=1"
2020-08-26 15:25:09 +08:00
},
{
2021-08-03 10:11:51 +08:00
"type": "button",
2020-08-26 15:25:09 +08:00
"label": "ajax 请求成功后关闭弹框",
"actionType": "ajax",
"api": "/api/mock2/form/saveForm?waitSeconds=1",
2020-08-26 15:25:09 +08:00
"close": true
}
]
}
}
```
2021-03-16 10:16:54 +08:00
## 配置弹窗的按钮
可以通过设置 `actions` 来控制弹窗中的按钮。
```schema: scope="body"
{
"type": "button-toolbar",
"buttons": [
{
"type": "button",
"label": "无按钮",
"actionType": "dialog",
"dialog": {
"title": "提示",
"actions": [],
"body": "无按钮的弹框"
}
},
{
"type": "button",
"label": "只有一个确认按钮",
"actionType": "dialog",
"dialog": {
"title": "提示",
"actions": [{
"type": "button",
"actionType": "confirm",
"label": "OK",
"primary": true
}],
"body": "只有一个 OK 的弹框"
}
}
]
}
```
2020-07-28 10:03:53 +08:00
## 弹框中配置表单
### 基本使用
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹个表单",
"actionType": "dialog",
"dialog": {
"title": "在弹框中的表单",
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=2",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "input-text",
2020-07-28 10:03:53 +08:00
"name": "username",
"required": true,
"placeholder": "请输入用户名",
"label": "用户名"
},
{
"type": "input-password",
2020-07-28 10:03:53 +08:00
"name": "password",
"label": "密码",
"required": true,
"placeholder": "请输入密码"
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
}
}
}
```
2020-07-29 16:20:21 +08:00
### 提交表单 或 ajax 请求
2020-07-28 10:03:53 +08:00
弹框中通过配置`form`或`ajax`行为按钮,可以实现`form`提交和`ajax`请求操作。
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹个表单",
"actionType": "dialog",
"dialog": {
"title": "在弹框中的表单",
"actions": [
{
"label": "提交表单",
"actionType": "submit",
"primary": true,
"type": "button"
},
{
"label": "ajax请求",
"actionType": "ajax",
"primary": true,
"type": "button",
"api": "/api/mock2/form/saveForm?waitSeconds=2"
2020-07-28 10:03:53 +08:00
}
],
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=2",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "input-text",
2020-07-28 10:03:53 +08:00
"name": "text",
"required": true,
"label": "用户名",
"placeholder": "请输入用户名"
},
{
"type": "input-password",
2020-07-28 10:03:53 +08:00
"name": "password",
"label": "密码",
"placeholder": "请输入密码",
"required": true
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
}
}
}
```
### 提交表单 或 ajax 请求后不关闭弹框
2020-07-28 10:03:53 +08:00
默认情况下,当弹框中配置了 form 并进行了**提交表单操作confirm**或进行了**`ajax`请求**,请求成功后,会自动关闭当前弹框,你可以通过手动设置`"close": false` 来禁止该默认特性。
2020-07-28 10:03:53 +08:00
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹个表单",
"actionType": "dialog",
"dialog": {
"title": "在弹框中的表单",
"actions": [
{
"label": "提交表单后不关闭",
"actionType": "submit",
"close": false,
"primary": true,
"type": "button"
},
{
"label": "ajax请求后不关闭",
"actionType": "ajax",
"primary": true,
"type": "button",
"api": "/api/mock2/form/saveForm?waitSeconds=2"
2020-07-28 10:03:53 +08:00
}
],
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=2",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "input-text",
2020-07-28 10:03:53 +08:00
"name": "text",
"required": true,
"label": "用户名",
"placeholder": "请输入用户名"
},
{
"type": "input-password",
2020-07-28 10:03:53 +08:00
"name": "password",
"label": "密码",
"required": true,
"placeholder": "请输入密码"
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
}
}
}
```
## feedback 反馈弹框
2020-07-29 16:20:21 +08:00
feedback 反馈弹框是指,在 ajax 请求后,可以显示一个弹框,进行反馈操作
2020-07-28 10:03:53 +08:00
### feedback 基本使用
2020-07-28 10:03:53 +08:00
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "Feedback",
"actionType": "ajax",
"api": "/api/mock2/form/initData?waitSeconds=2",
2020-07-28 10:03:53 +08:00
"tooltip": "点击我后会发送一个请求,请求回来后,弹出一个框。",
"feedback": {
"title": "操作成功",
"body": "xxx 已操作成功"
}
}
```
### 弹框中配置 feedback
#### 关闭 feedback 弹框时,同时关闭上层弹框
2020-07-29 16:20:21 +08:00
当你在弹框中配置了 feedback操作之后你希望关闭当前 feedback 弹框同时,关闭上层的弹框,具体有两种方式
2020-07-28 10:03:53 +08:00
##### 1. 不请求接口,直接关闭
`feedback`的`actions`中配置 `"actionType": "close"` 的按钮
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹一个框",
"actionType": "dialog",
"dialog": {
"title": "提示",
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=2",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "input-text",
2020-07-28 10:03:53 +08:00
"name": "text",
"required": true,
"label": "用户名",
"placeholder": "请输入用户名"
},
{
"type": "input-password",
2020-07-28 10:03:53 +08:00
"name": "password",
"label": "密码",
"required": true,
"placeholder": "请输入密码"
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
},
"actions": [
{
"type": "button",
"label": "提交表单 Feedback",
"actionType": "confirm",
"feedback": {
"body": "feedback弹框中不请求接口了直接点击按钮关闭",
"actions": [
{
"type": "button",
"actionType": "close",
"label": "关闭"
}
]
}
},
{
"type": "button",
"label": "ajax请求 Feedback",
"actionType": "ajax",
"close": true,
"api": "/api/mock2/form/initData?waitSeconds=1",
2020-07-28 10:03:53 +08:00
"feedback": {
"body": "feedback弹框中不请求接口了直接点击按钮关闭",
"actions": [
{
"type": "button",
"actionType": "close",
"label": "关闭"
}
]
}
}
]
}
}
```
##### 2. 请求接口,请求成功后,关闭所有弹框
2020-07-29 16:20:21 +08:00
需要在 feedback 的 `body` 中添加 Form 组件,并配置`"actionType": "confirm"`
2020-07-28 10:03:53 +08:00
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹一个框",
"actionType": "dialog",
"dialog": {
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=2",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "input-text",
2020-07-28 10:03:53 +08:00
"name": "text",
"required": true,
"label": "用户名",
"placeholder": "请输入用户名"
},
{
"type": "input-password",
2020-07-28 10:03:53 +08:00
"name": "password",
"label": "密码",
"required": true,
"placeholder": "请输入密码"
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
},
"actions": [
{
"type": "button",
"label": "confirm Feedback",
"actionType": "confirm",
"feedback": {
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=1",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "tpl",
"tpl": "点击确认,请求接口,接口请求成功后,关闭弹框"
}
]
},
"actions": [
{
"type": "button",
"actionType": "confirm",
"label": "确认",
"primary": true
}
]
}
},
{
"type": "button",
"label": "ajax Feedback",
"actionType": "ajax",
"close": true,
"api": "/api/mock2/form/saveForm?waitSeconds=1",
2020-07-28 10:03:53 +08:00
"feedback": {
"body": {
"type": "form",
"api": "/api/mock2/form/saveForm?waitSeconds=1",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "tpl",
"tpl": "点击确认,请求接口,接口请求成功后,关闭弹框"
}
]
},
"actions": [
{
"type": "button",
"actionType": "confirm",
"label": "确认",
"primary": true
}
]
}
}
]
}
}
```
> 注意上面的例子:如果你的触发`feedback`的按钮`actionType`为`ajax`时,为需要额外在按钮上配置`"close": true`
#### 取消 feedback 弹框时,不同时关闭上层弹框
2020-07-28 10:03:53 +08:00
2020-07-29 16:20:21 +08:00
改场景只适用于**不请求接口关闭弹框**的场景,需要在 feedback 层添加`"skipRestOnCancel": true`
2020-07-28 10:03:53 +08:00
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "弹一个框",
"actionType": "dialog",
"dialog": {
"title": "提示",
"body": {
"type": "form",
"api": "/api/mock2/form/initData?waitSeconds=1",
"body": [
2020-07-28 10:03:53 +08:00
{
"type": "tpl",
"tpl": "这是一个简单的弹框"
}
]
},
"actions": [
{
"type": "button",
"actionType": "confirm",
"label": "Feedback",
"feedback": {
"body": "这是一个feedback弹框",
"skipRestOnCancel": true,
"actions": [
{
"type": "button",
"actionType": "close",
"label": "关闭"
}
]
}
}
]
}
}
```
#### 确认 feedback 弹框时,不同时关闭上层弹框
如果想让 feedback 弹框确认后,让之前触发这个 feedback 的按钮中断,那么需要配置 `skipRestOnConfirm`,这就意味着之前触发这个 feedback 的按钮必须重新提交一次。
2020-07-28 10:03:53 +08:00
### 根据条件显示 feedback
2020-07-29 16:20:21 +08:00
可以根据条件弹出,例如下面这个例子,只有当接口返回的时间戳可以整除 2 时才显示弹框。
2020-07-28 10:03:53 +08:00
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "button",
"label": "条件feedback",
"actionType": "ajax",
"api": "/api/mock2/form/initData?waitSeconds=1",
2020-07-28 10:03:53 +08:00
"feedback": {
"visibleOn": "!(this.date % 2)",
"title": "操作成功",
"body": "当前时间戳: <code>${date}</code>"
}
}
```
## 配置 Esc 键和点击外部关闭弹框
可以通过配置 `closeOnEsc``closeOnOutside` 支持用 esc 键和点击其它区域关闭弹框。
```schema: scope="body"
{
"label": "点击弹框",
"type": "button",
"actionType": "dialog",
"dialog": {
"closeOnEsc": true,
"closeOnOutside": true,
"title": "弹框标题",
"body": [
{
"type": "input-text",
"label": "更复杂的标签提示",
"labelRemark": {
"trigger": ["click"],
"type": "remark",
"title": "提示",
"content": "<pre>first \nsecond\n${text1}</pre>"
},
"name": "text3"
},
{
"label": "点击弹框2",
"type": "button",
"actionType": "dialog",
"dialog": {
"closeOnEsc": true,
"closeOnOutside": true,
"title": "弹框标题2",
"body": "内容"
}
}
]
}
}
```
2020-07-28 10:03:53 +08:00
## 属性表
| 属性名 | 类型 | 默认值 | 说明 |
| --------------- | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------ |
| type | `string` | | `"dialog"` 指定为 Dialog 渲染器 |
| title | [SchemaNode](../../docs/types/schemanode) | | 弹出层标题 |
| body | [SchemaNode](../../docs/types/schemanode) | | 往 Dialog 内容区加内容 |
2022-05-31 15:05:54 +08:00
| size | `string` | | 指定 dialog 大小,支持: `xs`、`sm`、`md`、`lg`、`xl`、`full` |
| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 |
| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog |
| showCloseButton | `boolean` | `true` | 是否显示右上角的关闭按钮 |
| showErrorMsg | `boolean` | `true` | 是否在弹框左下角显示报错信息 |
| showLoading | `boolean` | `true` | 是否在弹框左下角显示 loading 动画 |
| disabled | `boolean` | `false` | 如果设置此属性,则该 Dialog 只读没有提交操作。 |
| actions | Array<[Action](./action)> | 【确认】和【取消】 | 如果想不显示底部按钮,可以配置:`[]` |
| data | `object` | | 支持[数据映射](../../docs/concepts/data-mapping),如果不设定将默认将触发按钮的上下文中继承数据。 |
## 事件表
当前组件会对外派发以下事件,可以通过`onEvent`来监听这些事件,并通过`actions`来配置执行的动作,在`actions`中可以通过`${事件参数名}`来获取事件产生的数据,详细请查看[事件动作](../../docs/concepts/event-action)。
2022-05-31 15:05:54 +08:00
> `[name]`为当前数据域中的字段名,例如:当前数据域为 {username: 'amis'},则可以通过${username}获取对应的值。
| 事件名称 | 事件参数 | 说明 |
| -------- | ------------------------------------------------------------------------ | ------------------ |
| confirm | `event.data: object` 弹窗数据<br/>`[name]: any` 当前数据域中指定字段的值 | 点击确认提交时触发 |
| cancel | `event.data: object` 弹窗数据<br/>`[name]: any` 当前数据域中指定字段的值 | 点击取消时触发 |
## 动作表
2022-05-31 15:05:54 +08:00
当前组件对外暴露以下特性动作,其他组件可以通过指定`actionType: 动作名称`、`componentId: 该组件id`来触发这些动作,动作配置可以通过`args: {动作配置项名称: xxx}`来配置具体的参数,详细请查看[事件动作](../../docs/concepts/event-action#触发其他组件的动作)。
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------- | ------------ |
| confirm | - | 确认(提交) |
| cancel | - | 取消(关闭) |
| setValue | `value: object` 更新的数据 | 更新数据 |