---
title: 事件动作
description: 事件动作
type: 0
group: 💡 概念
menuName: 事件动作
icon:
order: 9
---
> 1.7.0 及以上版本
上一节我们介绍了如何实现联动，是比较基础和局限的，而事件动作是更简单、更灵活、更高级的用法，可以解决复杂的 UI 交互场景，支持渲染器事件监听和响应设计，无需关心组件层级关系。例如：
- 传递数据
- 点击「按钮」，发送一个远程请求，返回的数据回填给一个表单
- 弹窗提交后，将弹窗内表单数据回填给另一个表单
- 联动刷新
- 下拉选择不同项，联动刷新表单数据
- 状态控制
- 勾选不同按钮，控制相应组件的显示/隐藏
- 勾选不同按钮，控制相应组件的启用/禁用
- 多个组件监听同一个事件做出不同响应
- 下拉选择不同项，组件 A 监听后发送一个远程请求，组件 B 监听后进行刷新
- 逻辑编排
- 针对监听到的事件，循环执行一些动作作为响应，还可以控制循环跳出或跳过
- 针对监听到的事件，根据条件选择性的执行动作响应
- 针对监听到的事件，并行执行多个动作作为响应
- 执行完当然动作后，可以选择是否继续执行后续动作，是否关闭事件默认行为的执行
## 基本使用
通过`onEvent`属性实现渲染器事件与响应动作的绑定。`onEvent`内配置事件和动作映射关系，`actions`是事件对应的响应动作的集合。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '尝试点击我、鼠标移入移出',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '派发点击事件'
}
]
},
mouseenter: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '派发鼠标移入事件'
}
]
},
mouseleave: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '派发鼠标移出事件'
}
]
}
}
}
]
}
```
## 事件
事件包含`渲染器事件`和`广播事件`。
- 渲染器事件，由具体的渲染器组件提供，每个渲染器组件暴露的事件可以查看具体的[组件文档](./components/page)；
- 广播事件，即自定义事件，可以自定义派发的事件名称`eventName`，其他渲染器可以监听该自定义事件并配置响应动作。
## 动作
动作包含`通用动作`、`组件动作`、`广播动作`、`自定义动作`，可以通过配置`actionType`来指定具体执行什么动作。
### 触发通用动作
通用动作包含发送 http 请求、跳转链接、打开/关闭弹窗、打开/关闭抽屉、打开对话框、弹出 Toast 提示、刷新、控制显示隐藏、控制启用禁用状态。
#### 发送 http 请求
通过配置`actionType: 'ajax'`和`api`实现 http 请求发送。
```schema
{
type: 'page',
body: [
{
type: 'button',
id: 'b_001',
label: '发送Ajax请求',
onEvent: {
click: {
actions: [
{
actionType: 'ajax',
api: 'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm',
messages: {
success: '成功了！欧耶',
failed: '失败了呢。。'
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ------------------------------ | ------ | -------------------- |
| actionType | `string` | `ajax` | 点击后显示一个弹出框 |
| api | [API](../../../docs/types/api) | - | 请求接口配置 |
#### 打开弹窗（模态）
通过配置`actionType: 'dialog'`和`dialog`实现 Dialog 弹窗。
```schema
{
type: 'page',
body: [
{
type: 'button',
className: 'ml-2',
label: '打开弹窗（模态）',
actionType: 'reload',
dialog: {
title: '系统提示',
body: '对你点击了'
},
onEvent: {
click: {
actions: [
{
actionType: 'dialog',
dialog: {
type: 'dialog',
title: '模态弹窗',
body: [
{
type: 'tpl',
tpl: '对，你打开了模态弹窗
',
inline: false
}
]
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------------------------- | -------- | ------------------------------------------ |
| actionType | `string` | `dialog` | 点击后显示一个弹出框 |
| dialog | `string` 或 `DialogObject` | - | 指定弹框内容，格式可参考[Dialog](./dialog) |
#### 关闭弹窗（模态）
通过配置`actionType: 'closeDialog'`实现关闭当前弹窗；附加配置`componentId`可以实现关闭指定弹窗。
```schema
{
type: 'page',
body: [
{
type: 'button',
id: 'b_003',
label: '打开弹窗（模态）',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'dialog',
dialog: {
type: 'dialog',
id: 'dialog_1',
title: '模态弹窗',
body: [
{
type: 'button',
label: '打开子弹窗，然后关闭它的父亲',
onEvent: {
click: {
actions: [
{
actionType: 'dialog',
dialog: {
type: 'dialog',
title: '模态子弹窗',
body: [
{
type: 'button',
label: '关闭指定弹窗（关闭父弹窗）',
onEvent: {
click: {
actions: [
{
actionType: 'closeDialog',
componentId: 'dialog_1'
}
]
}
}
}
]
}
}
]
}
}
},
{
type: 'button',
label: '关闭当前弹窗',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'closeDialog'
}
]
}
}
}
]
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | ------------- | --------------- |
| actionType | `string` | `closeDialog` | 关闭弹窗 |
| componentId | `string` | - | 指定弹框组件 id |
#### 打开抽屉（模态）
通过配置`actionType: 'drawer'`和`drawer`实现 Drawer 抽屉打开。
```schema
{
type: 'page',
body: [
{
type: 'button',
id: 'b_004',
className: 'ml-2',
label: '打开抽屉（模态）',
onEvent: {
click: {
actions: [
{
actionType: 'drawer',
drawer: {
type: 'drawer',
id: 'drawer_1',
title: '模态抽屉',
body: [
{
type: 'tpl',
tpl: '对，你打开了模态抽屉
',
inline: false
}
]
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------------------------- | -------- | ------------------------------------------ |
| actionType | `string` | `drawer` | 点击后显示一个侧边栏 |
| drawer | `string` 或 `DrawerObject` | - | 指定弹框内容，格式可参考[Drawer](./drawer) |
#### 关闭抽屉（模态）
通过配置`actionType: 'closeDrawer'`实现关闭当前抽屉；附加配置`componentId`可以实现关闭指定抽屉。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '打开抽屉（模态）',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'drawer',
drawer: {
type: 'drawer',
id: 'drawer_1',
title: '模态抽屉',
body: [
{
type: 'button',
label: '打开子抽屉，然后关闭它的父亲',
onEvent: {
click: {
actions: [
{
actionType: 'drawer',
drawer: {
type: 'drawer',
title: '模态子抽屉',
body: [
{
type: 'button',
label: '关闭指定抽屉(关闭父抽屉)',
onEvent: {
click: {
actions: [
{
actionType: 'closeDrawer',
componentId: 'drawer_1'
}
]
}
}
}
]
}
}
]
}
}
},
{
type: 'button',
label: '关闭当前抽屉',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'closeDrawer'
}
]
}
}
}
]
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | ------------- | --------------- |
| actionType | `string` | `closeDrawer` | 关闭抽屉 |
| componentId | `string` | - | 指定抽屉组件 id |
#### 打开对话框
通过配置`actionType: 'alert'`或`actionType: 'confirm'`打开不同对话框。
**提示对话框**
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '提示对话框（模态）',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'alert',
msg: '该吃饭了~'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ------- | -------------- |
| actionType | `string` | `alert` | 打开提示对话框 |
| msg | `string` | - | 对话框提示内容 |
**确认对话框**
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '确认对话框（模态）',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'confirm',
title: '操作确认',
msg: '要删除它吗？'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | --------- | -------------- |
| actionType | `string` | `confirm` | 打开确认对话框 |
| title | `string` | - | 对话框标题 |
| msg | `string` | - | 对话框提示内容 |
#### 跳转链接
通过配置`actionType: 'url'`或`actionType: 'link'`实现链接跳转。
**打开页面链接**
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '百度一下',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'url',
url: 'http://www.baidu.com',
blank: true
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | --------- | ------- | ------------------------------------------------ |
| actionType | `string` | `url` | 页面跳转 |
| url | `string` | - | 按钮点击后，会打开指定页面。可用 `${xxx}` 取值。 |
| blank | `boolean` | `false` | 如果为 `true` 将在新 tab 页面打开。 |
**打开单页链接**
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '跳转至表达式',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'link',
link: './expression'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| actionType | `string` | `link` | 单页跳转 |
| link | `string` | `link` | 用来指定跳转地址，跟 url 不同的是，这是单页跳转方式，不会渲染浏览器，请指定 amis 平台内的页面。可用 `${xxx}` 取值。 |
#### 回退页面
通过配置`actionType: 'goBack'`实现页面回退。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '回退',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'goBack'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | -------- | ------------ |
| actionType | `string` | `goBack` | 返回上个页面 |
#### 前进/后退到指定页面
通过配置`actionType: 'goPage'`实现浏览器页面的前进/后退。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '后退到上上个页面',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'goPage',
delta: -2
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | -------- | --------------- |
| actionType | `string` | `goPage` | 前进/后退到页面 |
| delta | `string` | `0` | 位置 |
#### 刷新页面
通过配置`actionType: 'refresh'`实现浏览器刷新。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '刷新页面',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'refresh'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | --------- | ------------ |
| actionType | `string` | `refresh` | 返回上个页面 |
#### toast 提示
通过配置`actionType: 'toast'`和`msg`实现弹出 toast
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '警告',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'warning',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-right'
}
}
]
}
}
},
{
type: 'button',
label: '成功',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'success',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-right'
}
}
]
}
}
},
{
type: 'button',
label: '错误',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'error',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-right'
}
}
]
}
}
},
{
type: 'button',
label: '提示',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-right'
}
}
]
}
}
},
{
type: 'tpl',
tpl: '
'
},
{
type: 'button',
label: '左上',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-left'
}
}
]
}
}
},
{
type: 'button',
label: '中上',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-center'
}
}
]
}
}
},
{
type: 'button',
label: '右上',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'top-right'
}
}
]
}
}
},
{
type: 'button',
label: '左下',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'bottom-left'
}
}
]
}
}
},
{
type: 'button',
label: '中下',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'bottom-center'
}
}
]
}
}
},
{
type: 'button',
label: '右下',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'toast',
msgType: 'info',
msg: '我是全局警告消息，可以配置不同类型和弹出位置~',
options: {
position: 'bottom-right'
}
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------- |
| actionType | `string` | `"toast"` | 指定 toast 动作 |
| msgType | `string` | | 消息类型 `"info"、"success"、"error"、"warning"`｜ |
| msg | `string` | | 消息内容 |
| options | `object` | | 其他配置项
{
position: `top-left`、`top-center`、`top-right`、`bottom-left`、`bottom-center`、`bottom-right`
} |
#### 复制
通过配置`actionType: 'copy'`和复制属性实现文本的复制操作。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '复制一段文本',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'copy',
content: 'http://www.baidu.com'
}
]
}
}
},
{
type: 'button',
label: '复制一段富文本',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'copy',
copyFormat: 'text/html',
content: "link bold"
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ------------------------------------ | ----------- | ------------------------------------ |
| actionType | `string` | `copy` | 复制一段内容到粘贴板 |
| copyFormat | `string` | `text/html` | 复制格式 |
| content | [模板](../../docs/concepts/template) | - | 指定复制的内容。可用 `${xxx}` 取值。 |
#### 发送邮件
通过配置`actionType: 'email'`和邮件属性实现发送邮件操作。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '发送邮件',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'email',
to: 'amis@baidu.com',
cc: 'baidu@baidu.com',
subject: '这是邮件主题',
body: '这是邮件正文'
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ------- | -------------------------------- |
| actionType | `string` | `email` | 点击后显示一个弹出框 |
| to | `string` | - | 收件人邮箱，可用 ${xxx} 取值。 |
| cc | `string` | - | 抄送邮箱，可用 ${xxx} 取值。 |
| bcc | `string` | - | 匿名抄送邮箱，可用 ${xxx} 取值。 |
| subject | `string` | - | 邮件主题，可用 ${xxx} 取值。 |
| body | `string` | - | 邮件正文，可用 ${xxx} 取值。 |
#### 刷新
通过配置`actionType: 'reload'`实现对指定组件的刷新操作，限于`form`、`dialog`、`drawer`、`wizard`、`service`、`page`、`service`、`app`、`chart`、`crud`，以及选择类组件。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '刷新(表单)',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'reload',
componentId: 'form-reload'
}
]
}
}
},
{
type: 'button',
label: '刷新(下拉框)',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'reload',
componentId: 'select-reload'
}
]
}
}
},
{
label: '下拉框',
type: 'select',
id: 'select-reload',
mode: 'horizontal',
className: 'm-t',
name: 'select',
source:
'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/getOptions?waitSeconds=1'
},
{
type: 'form',
id: 'form-reload',
name: 'form-reload',
initApi:
'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/page/initData',
title: '表单',
body: [
{
type: 'input-text',
id: 'date-input-01',
name: 'date',
label: '时间戳'
}
]
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | -------- | --------------------- |
| actionType | `string` | `reload` | 刷新组件 |
| componentId | `string` | - | 指定刷新的目标组件 id |
#### 显示与隐藏
通过配置`actionType: 'show'`或`'hidden'`实现对指定组件的显示和隐藏。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '显示',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'show',
componentId: 'input-text_001'
}
]
}
}
},
{
type: 'button',
label: '隐藏',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'hidden',
componentId: 'input-text_001'
}
]
}
}
},
{
type: 'input-text',
label: '愿望',
id: 'input-text_001',
mode: 'horizontal'
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | ------------------ | --------------------------- |
| actionType | `string` | `show` or `hidden` | 显示或隐藏组件 |
| componentId | `string` | - | 指定显示或隐藏的目标组件 id |
#### 控制状态
通过配置`actionType: 'enabled'`或`actionType: 'disabled'`实现对指定组件的启用和禁用，限于数据输入类组件。
```schema
{
type: 'page',
body: [
{
type: 'button',
id: 'b_dis',
label: '禁用',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'disabled',
componentId: 'form_disable'
}
]
}
}
},
{
type: 'button',
label: '启用',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'enabled',
componentId: 'form_disable'
}
]
}
}
},
{
type: 'form',
id: 'form_disable',
title: '表单',
body: [
{
type: 'group',
body: [
{
type: 'button',
className: 'ml-2',
label: '我的状态变了'
},
{
type: 'button',
className: 'ml-2',
label: '禁用上面的按钮',
onEvent: {
click: {
actions: [
{
actionType: 'disabled',
componentId: 'b_dis'
}
]
}
}
},
{
type: 'button',
className: 'ml-2',
label: '启用用上面的按钮',
onEvent: {
click: {
actions: [
{
actionType: 'enabled',
componentId: 'b_dis'
}
]
}
}
}
]
}
]
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | ----------------------- | --------------------------- |
| actionType | `string` | `enabled` or `disabled` | 启用或禁用组件 |
| componentId | `string` | - | 指定启用或禁用的目标组件 id |
#### 更新数据
通过配置`actionType: 'setValue'`实现组件数据变量的更新，限于`form`、`dialog`、`drawer`、`wizard`、`service`、`page`、`app`、`chart`，以及数据输入类组件。
**更新表单数据**
```schema
{
type: 'page',
data: {
globalData: {
myrole: '法官',
mymsg: '该吃饭了!'
}
},
body: [
{
type: 'button',
label: '更新',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'setValue',
componentId: 'form_data',
value: '${globalData}'
}
]
}
}
},
{
type: 'form',
id: 'form_data',
title: '表单',
debug: true,
data: {
myrole: '预言家',
age: '18'
},
"initApi": "/api/mock2/form/initData",
body: [
{
type: 'input-text',
label: '角色',
name: 'myrole',
disabled: false,
mode: 'horizontal'
},
{
type: 'input-text',
label: '年龄',
name: 'age',
disabled: false,
mode: 'horizontal'
}
]
}
]
}
```
**更新输入类组件数据**
```schema
{
type: 'page',
id: 'mypage',
data: {
globalData: {
myrole: '法官',
mymsg: '该吃饭了!',
title: 'beijing time'
}
},
body: [
{
type: 'button',
label: '更新',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'setValue',
componentId: 'input_data_msg',
value: '我是amis!'
}
]
}
}
},
{
type: 'button',
label: '更新表单内输入框',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'setValue',
componentId: 'input_data_role',
value: '预言家'
}
]
}
}
},
{
type: "input-text",
label: "消息",
id: "input_data_msg",
mode: 'horizontal',
name: "mymsg"
},
{
type: 'form',
title: '表单',
debug: true,
data: {
myrole: '杀手',
age: '18'
},
"initApi": "/api/mock2/form/initData",
body: [
{
type: 'input-text',
id: "input_data_role",
label: '角色',
name: 'myrole',
disabled: false,
mode: 'horizontal'
},
{
type: 'input-text',
label: '年龄',
name: 'age',
disabled: false,
mode: 'horizontal'
}
]
}
]
}
```
**更新 弹窗 数据**
这种场景一般用在弹窗内某个异步操作后，数据的回填。
```schema
{
type: 'page',
data: {
globalData: {
website: "http://www.baidu.com",
email: "amis!@baidu.com"
}
},
body: [
{
type: 'button',
label: '打开弹窗',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'dialog',
"dialog": {
"title": "在弹框中的表单",
"id": "dialog_data",
"data": {
username: 'amis'
},
"body": {
"type": "form",
"api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm?waitSeconds=2",
"body": [
{
"type": "input-text",
"name": "username",
"required": true,
"placeholder": "请输入用户名",
"label": "用户名"
},
{
"type": "input-password",
"name": "password",
"label": "密码",
"required": true,
"placeholder": "请输入密码"
},
{
"type": "checkbox",
"name": "rememberMe",
"label": "记住登录"
}
]
},
"actions": [
{
type: 'button',
label: '请求后更新',
className: 'm',
primary: true,
onEvent: {
click: {
actions: [
{
actionType: 'ajax',
api: 'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/initData',
outputVar: 'myResult'
},
{
actionType: 'setValue',
componentId: 'dialog_data',
value: {
username: '${myResult.name}'
}
}
]
}
}
}
]
}
}
]
}
}
}
]
}
```
**更新 向导 数据**
```schema
{
type: 'page',
data: {
globalData: {
website: "http://www.baidu.com",
email: "amis!@baidu.com"
}
},
body: [
{
type: 'button',
label: '更新',
className: 'ml-2 m',
onEvent: {
click: {
actions: [
{
actionType: 'setValue',
componentId: 'wizard_data',
value: '${globalData}'
}
]
}
}
},
{
"type": "wizard",
"id": "wizard_data",
"mode": "vertical",
"data": {
"website": "test",
"email": "test"
},
"steps": [
{
"title": "第一步",
"body": [
{
"name": "website",
"label": "网址",
"type": "input-url"
}
]
},
{
"title": "Step 2",
"body": [
{
"name": "email",
"label": "邮箱",
"type": "input-email",
"required": true
}
]
}
]
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ----------- | -------- | ---------- | ---------------------------- |
| actionType | `string` | `setValue` | 变量赋值，即设置组件的数据值 |
| componentId | `string` | - | 指定赋值的目标组件 id |
| value | `any` | - | 值 |
#### 自定义 JS
通过配置`actionType: 'custom'`实现自定义 JS。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '点我一下',
onEvent: {
click: {
actions: [
{
actionType: 'custom',
script:
"doAction({actionType: 'ajax',api: '/api/mock2/form/saveForm'});\n //event.stopPropagation();"
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| actionType | `string` | `custom` | 自定义 JS |
| script | `string` | | 自定义 JS 脚本代码，代码内可以通过调用`doAction`执行任何[动作](../../docs/concepts/event-action#动作) ，通过事件对象`event`可以实现事件动作干预 |
### 触发其他组件的动作
通过配置`componentId`来触发指定组件的动作，组件动作参考具体组件文档。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '选中选项卡2',
className: 'mr-3 mb-3',
onEvent: {
click: {
actions: [
{
actionType: 'changeActiveKey',
componentId: 'tabs-change-receiver',
activeKey: 1
}
]
}
}
},
{
id: 'tabs-change-receiver',
type: 'tabs',
mode: 'line',
tabs: [
{
title: '选项卡1',
body: '选项卡内容1'
},
{
title: '选项卡2',
body: '选项卡内容2'
},
{
title: '选项卡3',
body: '选项卡内容3'
}
]
}
]
}
```
### 触发广播动作
通过配置`actionType: 'broadcast'`和`eventName`实现触发一个广播，可以通过配置动作执行优先级`weight`来控制所有监听者的动作执行顺序。
```schema
{
type: 'page',
body: [
{
"name": "role",
"type": "select",
"label": "广播一下",
"mode": "row",
"options": [
{
"label": "海贼王的男人",
"value": "路飞"
},
{
"label": "海上华佗",
"value": "乔巴"
},
{
"label": "海上食神",
"value": "山治"
}
],
"onEvent": {
"change": {
"actions": [
{
actionType: 'broadcast',
eventName: 'broadcast_1',
args: {
myrole: '${role}',
age: 18
}
}
]
}
}
},
{
type: 'form',
id: 'form_001_form_01',
title: '表单1（优先级低）',
name: 'sub-form1',
body: [
{
type: 'input-text',
label: '昵称',
name: 'myname',
disabled: false,
mode: 'horizontal'
}
],
onEvent: {
broadcast_1: {
actions: [
{
actionType: 'reload',
args: {
myname: '${event.data.value}', // 从事件数据中取
}
},
{
"actionType": "toast",
"msgType": "info",
"msg": "表单1刷新完成"
}
]
}
}
},
{
type: 'form',
name: 'form2',
id: 'form_002',
title: '表单2（优先级中）',
body: [
{
type: 'input-text',
label: '角色',
name: 'myrole',
disabled: false,
mode: 'horizontal'
},
{
type: 'input-text',
label: '年龄',
name: 'age',
disabled: false,
mode: 'horizontal'
}
],
onEvent: {
broadcast_1: {
weight: 2,
actions: [
{
actionType: 'reload',
args: {
myrole: '${event.data.value}',
age: '${event.data.age}'
}
},
{
"actionType": "toast",
"msgType": "info",
"msg": "表单2刷新完成"
}
]
}
}
},
{
type: 'form',
name: 'form3',
id: 'form_003',
title: '表单3（优先级高）',
body: [
{
type: 'input-text',
id: 'form_003_text_01',
label: '职业',
name: 'job',
disabled: false,
mode: 'horizontal'
}
],
api: 'https://api/form/form3',
onEvent: {
broadcast_1: {
weight: 3,
actions: [
{
actionType: 'reload',
args: {
job: '${event.data.value}'
}
},
{
"actionType": "toast",
"msgType": "info",
"msg": "表单3刷新完成"
}
]
}
}
}
]
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ----------- | ------------------------------------------------ |
| actionType | `string` | `broadcast` | 广播动作 |
| eventName | `string` | | 广播动作对应的自定义事件名称，用于广播事件的监听 |
### 自定义动作
补充中...
## 编排动作
通过配置`actionType: 'for'`或`actionType: 'break'`或`actionType: 'continue'`或`actionType: 'switch'`或`actionType: 'parallel'`实现动作的逻辑编排，支持嵌套。
### 循环
```schema
{
type: 'page',
body: {
type: 'form',
wrapWithPanel: false,
data: {
loopData: [
{
name: 'lv',
age: '19'
},
{
name: 'xj',
age: '21'
}
]
},
body: [
{
type: 'button',
label: '循环发送两次请求，且每次携带了循环的数据',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'loop',
loopName: 'loopData',
args: {
level: 3
},
children: [
{
actionType: 'ajax',
api: 'https://api/form/loop-ajax-1?name=${name}&age=${age}'
}
]
}
]
}
}
}
]
}
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ---------------------------------------------------- | ------ | ------------------------------------- |
| actionType | `string` | `for` | 循环执行动作 |
| loopName | `string` | | 循环变量 |
| children | Array<[动作](../../docs/concepts/event-action#动作)> | - | 子动作，可以通过`break动作`来跳出循环 |
### Break 动作
```schema
{
type: 'page',
body: {
type: 'form',
wrapWithPanel: false,
data: {
loopData: [
{
name: 'lv',
age: '19'
},
{
name: 'xj',
age: '21'
}
]
},
body: [
{
type: 'button',
label: '只执行了第一个动作就跳出了循环',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'loop',
loopName: 'loopData',
children: [
{
"actionType": "toast",
"msgType": 'success',
"msg": '第一个动作',
options: {
position: 'top-right'
}
},
{
actionType: 'break'
},
{
"actionType": "toast",
"msgType": 'success',
"msg": '第一个dd动作',
options: {
position: 'top-right'
}
},
{
actionType: 'ajax',
api: 'https://api/form/loop-ajax-1?name=${name}?age=${age}'
}
]
}
]
}
}
}
]
}
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ------- | ------------ |
| actionType | `string` | `break` | 跳出循环动作 |
### Continue 动作
```schema
{
type: 'page',
body: {
type: 'form',
wrapWithPanel: false,
data: {
loopData: [
{
name: 'lv',
age: '19'
},
{
name: 'xj',
age: '21'
}
]
},
body: [
{
type: 'button',
label: '只循环执行第一个动作',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'loop',
loopName: 'loopData',
args: {
level: 3
},
children: [
{
"actionType": "toast",
"msgType": 'success',
"msg": '第一个动作',
options: {
position: 'top-right'
}
},
{
actionType: 'continue'
},
{
"actionType": "toast",
"msgType": 'success',
"msg": '最后的动作',
options: {
position: 'top-right'
}
}
]
}
]
}
}
}
]
}
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | -------- | ---------- | -------- |
| actionType | `string` | `continue` | 跳出当前 |
### 排他（switch）
```schema
{
type: 'page',
body: {
type: 'form',
wrapWithPanel: false,
data: {
branchCont: 18
},
body: [
{
type: 'button',
label: '只执行动作2',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'switch',
children: [
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作1',
options: {
position: 'top-right'
},
expression: 'this.branchCont > 19',
stopPropagation: true // 这里无效，因为条件不成立
},
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作2',
options: {
position: 'top-right'
},
expression: 'this.branchCont > 17'
},
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作3',
options: {
position: 'top-right'
},
expression: 'this.branchCont > 16'
}
]
}
]
}
}
}
]
}
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ---------------------------------------------------- | -------- | ------------------------------------------------------ |
| actionType | `string` | `switch` | 只执行第一个符合条件的动作 |
| children | Array<[动作](../../docs/concepts/event-action#动作)> | - | 子动作，每个子动作可以通过配置`expression`来匹配的条件 |
### 并行
```schema
{
type: 'page',
body: {
type: 'form',
wrapWithPanel: false,
body: [
{
type: 'button',
label: '同时执行动作1、2',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'parallel',
children: [
{
"actionType": "alert",
"msg": '动作1'
},
{
"actionType": "toast",
"msgType": 'success',
"msg": '动作2',
options: {
position: 'top-right'
}
}
]
}
]
}
}
}
]
}
}
```
**动作属性**
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ---------------------------------------------------- | ---------- | ------------------------------------------ |
| actionType | `string` | `parallel` | 点击后显示一个弹出框 |
| children | Array<[动作](../../docs/concepts/event-action#动作)> | - | 指定弹框内容，格式可参考[Dialog](./dialog) |
## 动作间数据传递
从事件触发开始，整个数据流包含事件本身产生的事件数据和动作产生的动作数据，事件源头产生的数据在 AMIS 事件动作机制底层已经自动加入渲染器数据域，可以通过`event.data.xxx`直接获取，而部分动作产生的数据如何流动需要交互设计者进行介入，对于数据流动可以通过数据映射，将上一个动作产生的数据作为动作参数写入下一个动作。
**传递数据**
通过 `args` 指定输入的参数数据，它是一个键值对。
```schema
{
type: 'page',
body: [
{
type: 'button',
id: 'b_001',
label: '发一个广播，携带动作参数',
className: 'm',
onEvent: {
click: {
actions: [
{
actionType: 'broadcast',
eventName: 'broadcast_1',
args: {
name: 'lvxj',
age: 18
},
description: '一个按钮的点击事件'
}
]
}
}
},
{
type: 'form',
name: 'form1',
id: 'form_001',
title: '接收广播事件的参数',
debug: true,
body: [
{
type: 'input-text',
id: 'form_001_text_01',
label: '年龄',
name: 'age',
disabled: false,
mode: 'horizontal'
}
],
data: {
name: 'amis'
},
onEvent: {
broadcast_1: {
actions: [
{
actionType: 'reload',
args: {
age: '${event.data.age}'
}
}
]
}
}
}
]
}
```
**存储异步请求返回的数据**
通过 `outputVar` 指定输出的变量名，其他动作可以通过`${event.data.{{outputVar}}}`来获取变量值。
```schema
{
type: 'page',
body: [
{
type: 'button',
label: '发送Ajax请求，并把返回数据传给弹窗',
className: 'ml-2',
onEvent: {
click: {
actions: [
{
actionType: 'ajax',
api: 'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm',
messages: {
success: '成功了！欧耶',
failed: '失败了呢。。'
},
outputVar: 'ajax1'
},
{
actionType: 'dialog',
args: {
id: '${event.data.ajax1.id}'
},
dialog: {
type: 'dialog',
id: 'dialog_1',
title: '弹框标题1',
data: {
id: '${id}'
},
body: [
{
type: 'form',
body: [
{
type: 'tpl',
tpl: '请求返回的数据：id=${id}
',
inline: false
}
]
}
]
}
}
]
}
}
}
]
}
```
## 事件动作干预
事件动作干预是指执行完当前动作后，干预所监听事件默认处理逻辑和后续其他动作的执行。通过`preventDefault`、`stopPropagation`分别阻止监听事件默认行为和停止下一个动作执行。
**阻止事件默认行为**
```schema
{
"type": "page",
"title": "事件/动作干预",
"regions": [
"body",
"toolbar",
"header"
],
"body": [
{
"type": "button",
"label": "阻止弹窗",
"actionType": "dialog",
"dialog": {
"title": "系统提示",
"body": "对你点击了"
},
"onEvent": {
"click": {
"actions": [
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作1',
"preventDefault": true
}
]
}
}
}
]
}
```
**停止后续动作执行**
```schema
{
"type": "page",
"title": "事件/动作干预",
"regions": [
"body",
"toolbar",
"header"
],
"body": [
{
"type": "button",
"label": "停止执行动作3",
"className": "ml-2",
"onEvent": {
"click": {
"actions": [
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作1'
},
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作2',
"stopPropagation": true
},
{
"actionType": "toast",
"msgType": 'info',
"msg": '动作3'
}
]
}
}
}
]
}
```
## 典型场景
补充中...
## 通用属性表
| 属性名 | 类型 | 默认值 | 说明 |
| --------------- | -------------------------------- | ------ | ---------------- |
| actionType | `string` | | 动作名称 |
| args | `{key:value}` | | 动作参数 |
| preventDefault | `boolean` | false | 阻止事件默认行为 |
| stopPropagation | `boolean` | false | 停止后续动作执行 |
| execOn | [表达式](../concepts/expression) | | 执行条件 |
| outputVar | `string` | | 输出数据变量名 |