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(低信任度) | 當擷取資料失敗時觸發。 | 無 |
表單
| 事件 | 說明 | 資料 |
|---|---|---|
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
| 動作 | 說明 |
|---|---|
open (預設) | 開啟圖片燈箱，來源圖片是觸發動作的圖片。 |
amp-lightbox
| 動作 | 說明 |
|---|---|
open (預設) | 開啟燈箱。 |
close | 關閉燈箱。 |
amp-list
| 動作 | 說明 |
|---|---|
changeToLayoutContainer | 將 amp-list 的版面配置更新為 layout="CONTAINER"，以允許動態調整大小。 |
refresh | 從 src 重新整理資料，並重新轉譯清單。 |
amp-selector
| 動作 | 說明 |
|---|---|
clear | 清除已定義 amp-selector 的所有選取項目。 |
selectUp(delta=INTEGER) | 將選取項目向上移動 `delta` 的值。預設 `delta` 設定為 -1。如果未選取任何選項，則選取狀態將會變成最後一個選項的值。 |
selectDown(delta=INTEGER) | 將選取項目向下移動 `delta` 的值。預設 `delta` 設定為 1。如果未選取任何選項，則選取狀態將會變成第一個選項的值。 |
toggle(index=INTEGER, value=BOOLEAN) | 切換 `selected` 的應用。如果 select 屬性不存在，此動作會新增該屬性。如果 select 屬性存在，此動作會移除該屬性。您可以透過在 `value` 引數中包含布林值，強制並保留新增或移除。值為 `true` 將強制新增 `selected` 屬性，且即使已存在也不會移除。值為 `false` 將移除屬性，但即使不存在也不會新增。 |
amp-sidebar
| 動作 | 說明 |
|---|---|
open (預設) | 開啟側邊欄。 |
close | 關閉側邊欄。 |
toggle | 切換側邊欄的狀態。 |
表單
| 動作 | 說明 |
|---|---|
clear | 清除表單輸入中的任何值。 |
submit | 提交表單。 |
特殊目標
以下是 AMP 系統提供的目標，具有特殊需求
目標：AMP
AMP 目標由 AMP 執行階段提供，並實作適用於整個文件的最上層動作。
| 動作 | 說明 |
|---|---|
setState({foo: 'bar'})1 | 需要 amp-bind。 將物件常值合併到可繫結的狀態。 |
1當與多個動作搭配使用時，後續動作將會等待 setState() 完成後再叫用。每個事件僅允許單一 setState()。