動作和事件
本文件涵蓋 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 | 當元素被點擊/輕觸時觸發。 |
copy-success | 當內容/文字成功複製到剪貼簿時觸發。 |
copy-error | 當複製內容時發生錯誤時觸發。如果複製內容時發生錯誤，event.data.type 將設定為 error 值。如果瀏覽器不支援複製方法，event.data.type 將設定為 browser 值。 |
輸入元素
| 事件 | 說明 | 元素 | 資料 |
|---|---|---|---|
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(低信任度) | 擷取資料失敗時觸發。 | 無 |
amp-video 和其他影片元素
以下事件由 amp-video、amp-video-iframe 和 第三方影片播放器 (例如 amp-youtube) 派送。
| 事件 | 說明 | 資料 |
|---|---|---|
firstPlay(低信任度) | 使用者第一次播放影片時觸發。在自動播放影片上，這會在使用者與影片互動後立即觸發。此事件為低信任度，表示無法觸發大多數動作；只能執行低信任度動作，例如 amp-animation 動作。 | |
timeUpdate(低信任度) | 當影片的播放位置變更時觸發。事件的頻率由 AMP 控制，目前設定為 1 秒間隔。此事件為低信任度，表示無法觸發大多數動作；只能執行低信任度動作，例如 amp-animation 動作。 | {time, percent}time 表示目前的秒數，percent 是介於 0 和 1 之間的數字，表示目前位置佔總時間的百分比。 |
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 的值相同。 |
scrollTo(duration=INTEGER, position=STRING) | 以平滑動畫將元素捲動到檢視畫面中。duration 是選用項目。指定動畫的長度 (以毫秒為單位)。如果未指定，則會使用小於或等於 500 毫秒的捲動差異相關量。position 是選用項目。top、center 或 bottom 其中之一 (預設為 top)。指定元素在捲動後相對於檢視區的位置。作為協助工具最佳做法，請將此與呼叫 focus() 配對，以將焦點放在要捲動到的元素上。 |
focus | 讓目標元素取得焦點。若要失去焦點，請 focus 在另一個元素上 (通常是父元素)。我們強烈建議基於協助工具考量，不要透過將焦點放在 body/documentElement 上來失去焦點。 |
amp-audio
| 動作 | 說明 |
|---|---|
play | 播放音訊。如果 <amp-audio> 元素是 <amp-story> 的子系，則為空運算。 |
pause | 暫停音訊。如果 <amp-audio> 元素是 <amp-story> 的子系，則為空運算。 |
amp-bodymovin-animation
| 動作 | 說明 |
|---|---|
play | 播放動畫。 |
pause | 暫停動畫。 |
stop | 停止動畫。 |
seekTo(time=INTEGER) | 將動畫的 currentTime 設定為指定值並暫停動畫。 |
seekTo(percent=[0,1]) | 使用指定的百分比值來決定動畫的 currentTime 為指定值並暫停動畫。 |
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) | 將輪播前進到指定的幻燈片索引。 |
toggleAutoplay(toggleOn=true|false) | 切換輪播的自動播放狀態。toggleOn 是選用項目。 |
amp-image-lightbox
| 動作 | 說明 |
|---|---|
open (預設) | 開啟影像燈箱，來源影像為觸發動作的影像。 |
amp-lightbox
| 動作 | 說明 |
|---|---|
open (預設) | 開啟燈箱。 |
close | 關閉燈箱。 |
amp-lightbox-gallery
| 動作 | 說明 |
|---|---|
open | 開啟燈箱藝廊。如果指定影像 ID，可以透過輕觸另一個元素來觸發：`on="tap:amp-lightbox-gallery.open(id='image-id')"`。 |
amp-list
| 動作 | 說明 |
|---|---|
changeToLayoutContainer | 將 amp-list 的版面配置更新為 layout="CONTAINER"，以允許動態調整大小。 |
refresh | 從 src 重新整理資料並重新呈現清單。 |
amp-live-list
| 動作 | 說明 |
|---|---|
update (預設) | 更新 DOM 項目以顯示更新的內容。 |
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 | 切換側邊欄的狀態。 |
amp-state
| 動作 | 說明 |
|---|---|
refresh | 重新擷取 src 屬性中的資料，同時忽略瀏覽器快取。 |
amp-user-notification
| 動作 | 說明 |
|---|---|
dismiss (預設) | 隱藏參照的使用者通知元素。 |
amp-video 和其他影片元素
以下動作在 amp-video、amp-video-iframe 和 第三方影片播放器 (例如 amp-youtube) 中受到支援。
| 動作 | 說明 |
|---|---|
play | 播放影片。 |
pause | 暫停影片。 |
mute | 將影片設為靜音。 |
unmute | 取消影片靜音。 |
fullscreenenter | 將影片設為全螢幕。 |
form
| 動作 | 說明 |
|---|---|
clear | 清除表單輸入中的任何值。 |
submit | 提交表單。 |
特殊目標
以下是 AMP 系統提供的目標，具有特殊需求
目標：AMP
AMP 目標由 AMP 執行階段提供，並實作套用至整個文件的最上層動作。
| 動作 | 說明 | ||
|---|---|---|---|
navigateTo(url=STRING, target=STRING, opener=BOOLEAN) | 將目前視窗導覽至指定的 URL，以及選用的指定目標 (如果已指定；目前僅支援 注意事項： 建議盡可能使用一般的 | ||
closeOrNavigateTo(url=STRING, target=STRING, opener=BOOLEAN) | 嘗試關閉視窗 (如果允許)，否則會以類似於 注意事項： 建議盡可能使用一般的 | ||
goBack(navigate=BOOLEAN) | 在歷程記錄中返回導覽。`navigate` 是選用項目，如果設定為 true，則允許跨文件導覽，類似於 [history.back](https://developer.mozilla.org/en-US/docs/Web/API/History/back)。 | ||
print | 開啟列印對話方塊以列印目前頁面。 | ||
| scrollTo(id=STRING, duration=INTEGER, position=STRING) | 捲動至目前頁面上提供的元素 ID。 | ||
| optoutOfCid | 針對所有範圍選擇退出用戶端 ID 產生。 | ||
setState({foo: 'bar'})1 | 需要 amp-bind。 將物件常值合併到可繫結狀態。 | ||
pushState({foo: 'bar'})1 | 需要 amp-bind。 將物件常值合併到可繫結狀態，並將新項目推送至瀏覽器歷程記錄堆疊。彈出項目將還原變數的先前值 (在此範例中為 | ||
copy(text='content') | 將任何內容複製到剪貼簿。 | toggleTheme() | 在呼叫時切換 body 元素上的 amp-dark-mode 類別，並將使用者偏好設定為 localStorage。amp-dark-mode 類別預設會根據 prefers-color-scheme 值新增至 body。在 body 標籤上使用 data-prefers-dark-mode-class 屬性，以覆寫用於深色模式的類別。 |
1當與多個動作搭配使用時，後續動作將等待 setState() 或 pushState() 完成後再叫用。每個事件僅允許單一 setState() 或 pushState()。
目標：amp-access
amp-access 目標由 amp-access 元件提供。
amp-access 目標因以下原因而特殊
- 您無法為此目標指定任意 ID。目標永遠是
amp-access。 amp-access的動作是動態的，取決於AMP Access 組態的結構。
請參閱詳細資訊，以瞭解如何使用 amp-access 目標。