amp-date-countdown

1.0 0.1

<script async custom-element="amp-date-countdown" src="https://cdn.ampproject.org/v0/amp-date-countdown-0.1.js"></script>

用法

顯示倒數計時序列，以指出排定的事件發生前剩餘的時間。

amp-date-countdown 提供倒數計時時間資料，您可以在 AMP 頁面中呈現。藉由在 amp-date-countdown 標記中提供特定的屬性，amp-date-countdown 擴充功能會傳回時間參數清單，您可以將這些參數傳遞至 amp-mustache 範本以進行呈現。請參閱下方清單，以瞭解每個傳回的時間參數。

<amp-date-countdown
  timestamp-seconds="2147483648"
  layout="fixed-height"
  height="50"
>
  <template type="amp-mustache">
    <p class="p1">
{{d}} days, {{h}} hours, {{m}} minutes and {{s}} seconds until
      <a href="https://en.wikipedia.org/wiki/Year_2038_problem">Y2K38</a>.
    </p>
  </template>
</amp-date-countdown>

傳回的時間參數

下表列出您可以在 Mustache 範本中指定的格式

格式化值的範例

下表提供在 Mustache 範本中指定的格式化值範例，以及範例輸出

屬性

您必須至少指定下列其中一個必要屬性：end-date、timeleft-ms、timestamp-ms、timestamp-seconds。

end-date

要倒數計時到的 ISO 格式日期。例如，2020-06-01T00:00:00+08:00

timestamp-ms

以毫秒為單位的 POSIX 紀元值；假設為 UTC 時區。例如，timestamp-ms="1521880470000"。

timestamp-seconds

以秒為單位的 POSIX 紀元值；假設為 UTC 時區。例如，timestamp-seconds="1521880470"。

timeleft-ms

剩餘要倒數計時的值 (以毫秒為單位)。例如，剩餘 48 小時 timeleft-ms="172800000"。

offset-seconds (選填)

正數或負數，代表要從 end-date 新增或減去多少秒。例如，offset-seconds="60" 會將 60 秒新增至結束日期。

when-ended (選填)

指定計時器在達到 0 秒時是否停止。值可以設定為 stop (預設值)，表示計時器在 0 秒時停止，且不會超過最終日期；或者設定為 continue，表示計時器應在達到 0 秒後繼續。

locale (選填)

每個計時器單位的國際化語言字串。預設值為 en (英文)。

支援的值

biggest-unit (選填)

允許 amp-date-countdown 元件根據指定的 biggest-unit 值計算時間差。例如，假設剩餘 50 天 10 小時，如果 biggest-unit 設定為 hours，則結果會顯示剩餘 1210 小時。

• 支援的值：days、hours、minutes、seconds
• 預設值：days

data-count-up (選填)

加入此屬性可反轉倒數計時的方向，改為向上計時。這對於顯示自過去目標日期起經過的時間很有用。若要在目標日期已過時繼續計時，請務必加入 when-ended 屬性，並將值設為 continue。如果目標日期在未來，amp-date-countdown 會顯示遞減 (朝向 0) 的負值。

活動

amp-date-countdown 元件公開下列事件，您可以使用 AMP on-syntax 觸發

逾時

當計時器逾時時。若要使此動作發揮作用，必須將 when-ended 設定為 stop。計時器逾時時，您只能執行低信任度動作，例如 amp-animation 和 amp-video 動作。這是為了強制執行 AMP 的 UX 原則，即不允許頁面內容在沒有明確使用者動作的情況下重新排版。|

範例：示範逾時事件的用法

<h1 id="sample">
  When Timer hits 0, will hide the timer itself and hide this message.
</h1>

<amp-animation id="hide-timeout-event" layout="nodisplay">
  <script type="application/json">
    {
      "duration": "1s",
      "fill": "both",
      "selector": "#ampdate, #sample",
      "keyframes": {"visibility": "hidden"}
    }
  </script>
</amp-animation>
<amp-date-countdown
  id="ampdate"
  end-date="2018-07-17T06:19:40+08:00"
  on="timeout: hide-timeout-event.start"
  height="400"
  width="400"
  when-ended="stop"
  locale="en"
>
  <template type="amp-mustache">
    <h1>Countdown Clock</h1>
    <div>
{{dd}} : {{hh)) : {{mm}} : {{ss}}    </div>
  </template>
</amp-date-countdown>

呈現方式如下

驗證

請參閱 AMP 驗證器規格中的 amp-date-countdown 規則。