AMP 电子邮件中的操作和事件
本文档介绍了 AMP 电子邮件格式的操作和事件。请阅读操作和事件，了解 AMP 网站、故事和广告。
on 属性用于在元素上安装事件处理程序。支持的事件取决于元素。
该语法的取值是以下形式的简单领域特定语言
eventName:targetId[.methodName[(arg1=value, arg2=value)]]
请参阅下表了解语法各部分的描述。
| 语法 | 必需？ | 描述 |
|---|---|---|
eventName | 是 | 这是元素公开的事件的名称。 |
targetId | 是 | 这是元素 DOM ID，或要在响应事件时在其上执行操作的预定义特殊目标。在以下示例中，targetId 是 amp-lightbox 目标 photo-slides 的 DOM ID。<amp-lightbox id="photo-slides"></amp-lightbox> <button on="tap:photo-slides">Show Images</button> |
methodName | 否 | 这适用于具有默认操作的元素。 这是目标元素（由 AMP 有一个元素可以实现的默认操作的概念。因此，当省略 |
arg=value | 否 | 某些操作（如果已记录）可能会接受参数。参数在括号中以 key=value 表示法定义。接受的值是
|
处理多个事件
你可以通过使用分号 ; 分隔事件来监听元素上的多个事件。
示例：on="submit-success:lightbox1;submit-error:lightbox2"
一个事件的多个操作
你可以通过用逗号“,”分隔操作来按顺序对同一事件执行多个操作。
示例：on="tap:target1.actionA,target2.actionB"
全局定义的事件和操作
AMP 在全局范围内定义了一个 tap 事件，你可以在任何 HTML 元素（包括 AMP 元素）上监听该事件。
AMP 还在全局范围内定义了 hide、show 和 toggleVisibility 操作，你可以在任何 HTML 元素上触发这些操作。
仅当元素之前通过 hide 或 toggleVisibility 操作隐藏，或者通过使用 hidden 属性隐藏时，才能显示元素。show 操作不支持通过 CSS display:none 或 AMP 的 layout=nodisplay 隐藏的元素。
例如，以下在 AMP 中是可行的
<div id="warning-message">Warning...</div> <button on="tap:warning-message.hide">Cool, thanks!</button>
特定于元素的事件
* - 所有元素
| 事件 | 描述 |
|---|---|
tap | 在单击/点按元素时触发。 |
输入元素
| 事件 | 描述 | 元素 | 数据 |
|---|---|---|---|
change | 在元素的值更改并提交时触发。 数据属性镜像 HTMLInputElement 和 HTMLSelectElement 中的属性。 | input | event.min event.max event.value event.valueAsNumber |
input[type="radio"],input[type="checkbox"] | event.checked | ||
select | event.min event.max event.value | ||
input-debounced | 在元素的值更改时触发。这类似于标准的 change 事件，但仅在输入的数值停止更改 300 毫秒后触发。 | 触发 input 事件的元素。 | 与 change 事件数据相同。 |
input-throttled | 在元素的值更改时触发。这类似于标准的 change 事件，但在输入的值更改时，它最多每 100 毫秒触发一次。 | 触发 input 事件的元素。 | 与 change 事件数据相同。 |
amp-accordion > section
| 事件 | 描述 | 数据 |
|---|---|---|
expand | 在手风琴部分展开时触发。 | 无。 |
collapse | 在手风琴部分折叠时触发。 | 无。 |
amp-carousel[type="slides"]
| 事件 | 描述 | 数据 |
|---|---|---|
slideChange | 当轮播的当前幻灯片更改时触发。 | // Slide number. event.index |
amp-lightbox
| 事件 | 描述 | 数据 |
|---|---|---|
lightboxOpen | 在灯箱完全可见时触发。 | 无 |
lightboxClose | 在灯箱完全关闭时触发。 | 无 |
amp-list
| 事件 | 描述 | 数据 |
|---|---|---|
fetch-error（低信任度） | 在获取数据失败时触发。 | 无 |
amp-selector
| 事件 | 描述 | 数据 |
|---|---|---|
select | 在选择或取消选择某个选项时触发。 | // Target element's "option" attribute value. event.targetOption // Array of "option" attribute values of all selected elements. event.selectedOptions |
amp-sidebar
| 事件 | 描述 | 数据 |
|---|---|---|
sidebarOpen | 在过渡结束后边栏完全打开时触发。 | 无 |
sidebarClose | 在过渡结束后边栏完全关闭时触发。 | 无 |
amp-state
| 事件 | 描述 | 数据 |
|---|---|---|
fetch-error（低信任度） | 在获取数据失败时触发。 | 无 |
form
| 事件 | 描述 | 数据 |
|---|---|---|
submit | 在提交表单时触发。 | |
submit-success | 在表单提交响应成功时触发。 | // Response JSON. event.response |
submit-error | 在表单提交响应出现错误时触发。 | // Response JSON. event.response |
valid | 在表单有效时触发。 | |
invalid | 在表单无效时触发。 |
特定于元素的操作
*（所有元素）
| 操作 | 描述 |
|---|---|
hide | 隐藏目标元素。 |
show | 显示目标元素。如果autofocus 元素因此变得可见，则它会获得焦点。 |
toggleVisibility | 切换目标元素的可见性。如果autofocus 元素因此变得可见，则它会获得焦点。 |
toggleClass(class=STRING, force=BOOLEAN) | 切换目标元素的类。force 是可选的，如果已定义，则确保仅添加类，但如果设置为 true，则不会删除类；如果设置为 false，则仅删除类，但不会添加类。 |
toggleChecked(force=BOOLEAN) | 切换目标元素的选中状态。force 是可选的，如果已定义，则确保结果状态与 force 的值相同。 |
focus | 使目标元素获得焦点。要失去焦点，请对另一个元素（通常是父元素）执行 focus。出于辅助功能考虑，我们强烈建议不要通过聚焦于 body/documentElement 来失去焦点。 |
amp-accordion
| 操作 | 描述 |
|---|---|
toggle(section=STRING) | 切换 amp-accordion 部分的 expanded 和 collapsed 状态。当不带参数调用时，它会切换手风琴的所有部分。通过提供部分 ID 在特定部分上触发：on="tap:myAccordion.toggle(section='section-id')"。 |
expand(section=STRING) | 展开手风琴的各个部分。如果某个部分已展开，则它将保持展开状态。当不带参数调用时，它会展开手风琴的所有部分。通过提供部分 ID 在特定部分上触发：on="tap:myAccordion.expand(section='section-id')"。 |
collapse(section=STRING) | 折叠手风琴的各个部分。如果某个部分已折叠，则它将保持折叠状态。当不带参数调用时，它会折叠手风琴的所有部分。通过提供部分 ID 在特定部分上触发：on="tap:myAccordion.collapse(section='section-id')"。 |
amp-carousel[type="slides"]
| 操作 | 描述 |
|---|---|
goToSlide(index=INTEGER) | 将轮播前进到指定的幻灯片索引。 |
amp-image-lightbox
| 操作 | 描述 |
|---|---|
打开 (默认) | 打开图像灯箱，源图像为触发操作的图像。 |
amp-lightbox
| 操作 | 描述 |
|---|---|
打开 (默认) | 打开灯箱。 |
关闭 | 关闭灯箱。 |
amp-list
| 操作 | 描述 |
|---|---|
changeToLayoutContainer | 更新 amp-list 的布局为 layout="CONTAINER"，以允许动态调整大小。 |
刷新 | 从 src 刷新数据并重新渲染列表。 |
amp-selector
| 操作 | 描述 |
|---|---|
清除 | 清除已定义的 amp-selector 中的所有选择。 |
selectUp(delta=整数) | 将选择向上移动 `delta` 的值。默认 `delta` 设置为 -1。如果未选择任何选项，则选定的状态将变为最后一个选项的值。 |
selectDown(delta=整数) | 将选择向下移动 `delta` 的值。默认 `delta` 设置为 1。如果未选择任何选项，则选定的状态将变为第一个选项的值。 |
toggle(index=整数, value=布尔值) | 切换 `selected` 的应用。如果缺少 select 属性，此操作会添加它。如果存在 select 属性，此操作会删除它。您可以通过在 `value` 参数中包含布尔值来强制添加或删除。`true` 值将强制添加 `selected` 属性，如果已存在则不删除。`false` 值将删除该属性，但如果不存在则不会添加。 |
amp-sidebar
| 操作 | 描述 |
|---|---|
打开 (默认) | 打开侧边栏。 |
关闭 | 关闭侧边栏。 |
切换 | 切换侧边栏的状态。 |
form
| 操作 | 描述 |
|---|---|
清除 | 清除表单输入中的任何值。 |
submit | 提交表单。 |
特殊目标
以下是 AMP 系统提供的具有特殊要求的目标
目标：AMP
AMP 目标由 AMP 运行时提供，并实现应用于整个文档的顶级操作。
| 操作 | 描述 |
|---|---|
setState({foo: 'bar'})1 | 需要 amp-bind。 将对象字面量合并到可绑定的状态中。 |
1当与一个事件的多个操作一起使用时，后续操作将在 setState() 完成后才会被调用。每个事件只允许一个 setState()。