AMP

重要提示:此文档不适用于您当前选择的格式 email

amp-date-countdown

实验性
Bento

描述

显示到指定日期的倒计时序列。

 

必需脚本

<script async custom-element="amp-date-countdown" src="https://cdn.ampproject.org/v0/amp-date-countdown-1.0.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 模板中指定的格式

格式 含义
d 天 - 0, 1, 2,...12, 13..无穷大
dd 天 - 00, 01, 02, 03..无穷大
h 小时 - 0, 1, 2,...12, 13..无穷大
hh 小时 - 01, 02, 03..无穷大
m 分钟 - 0, 1, 2,...12, 13..无穷大
mm 分钟 - 01, 01, 02, 03..无穷大
s 秒 - 0, 1, 2,...12, 13..无穷大
ss 秒 - 00, 01, 02, 03..无穷大
days 天或天的国际化字符串
hours 小时或小时的国际化字符串
minutes 分钟或分钟的国际化字符串
seconds 秒或秒的国际化字符串

格式化值的示例

此表提供了在 Mustache 模板中指定的格式化值的示例,以及输出的示例

格式 示例输出 备注
{hh}:{mm}:{ss} 04:24:06 -
{h} {hours} 和 {m} {minutes} 和 {s} {seconds} 4 小时 1 分钟 45 秒 -
{d} {days} {h}:{mm} 1 天 5:03 -
{d} {days} {h} {hours} {m} {minutes} 50 天 5 小时 10 分钟 -
{d} {days} {h} {hours} {m} {minutes} 20 天 5 小时 10 分钟 -
{h} {hours} {m} {minutes} 240 小时 10 分钟 biggest-unit='hours'
{d} {days} {h} {hours} {m} {minutes} 50 天 5 小时 10 分钟 locale='zh-cn'

从 0.1 版本迁移

实验性的 1.0 版本的 amp-date-countdown 使用属性名称 count-up 而不是 0.1 中的 data-count-up 来支持“向上计数”功能。有关更多详细信息,请参阅下面 Attributes 下的 count-up 部分。

在有效的 AMP 文档之外独立使用

Bento 允许您在非 AMP 页面中使用 AMP 组件,而无需完全提交到有效的 AMP。您可以将这些组件放置在不支持 AMP 的框架和 CMS 的实现中。有关更多信息,请阅读我们的指南 在非 AMP 页面中使用 AMP 组件

要查找 amp-date-countdown 的独立版本,请参阅 bento-date-countdown

属性

您必须至少指定以下必需属性之一:end-datetimeleft-mstimestamp-mstimestamp-seconds

end-date

要倒计时的 ISO 格式的日期。例如,2020-06-01T00:00:00+08:00

timestamp-ms

以毫秒为单位的 POSIX epoch 值;假定为 UTC 时区。例如,timestamp-ms="1521880470000"

timestamp-seconds

以秒为单位的 POSIX epoch 值;假定为 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(表示英语)。

支持的值

代码 语言
de 德语
en 英语
es 西班牙语
fr 法语
id 印度尼西亚语
it 意大利语
ja 日语
ko 韩语
nl 荷兰语
pt 葡萄牙语
ru 俄语
th 泰语
tr 土耳其语
vi 越南语
zh-cn 简体中文
zh-tw 繁体中文

biggest-unit(可选)

允许 amp-date-countdown 组件基于指定的 biggest-unit 值计算时间差。例如,假设还剩 50 天 10 小时,如果 biggest-unit 设置为 hours,则结果显示还剩 1210 小时

  • 支持的值:dayshoursminutesseconds
  • 默认值:days

count-up(可选)

包含此属性以反转倒计时方向以改为向上计数。这对于显示自过去的某个目标日期起经过的时间非常有用。要在目标日期在过去时继续倒计时,请务必包含具有 continue 值的 when-ended 属性。如果目标日期在未来,amp-date-countdown 将显示一个递减(朝向 0)的负值。

请注意,属性名称与使用 data-count-up 属性切换此功能的 0.1 不同。该功能的行为在其他方面与 0.1 相同。

活动

amp-date-countdown 组件公开了以下事件,您可以使用 AMP on-syntax 来触发

超时

当计时器超时时。要使此操作起作用,必须when-ended 设置为 stop。计时器超时时,您只能运行低信任操作,例如 amp-animationamp-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>

呈现为

需要更多帮助?

您已经阅读了本文档十几次,但它并没有真正涵盖您所有的问题?也许其他人也有同感:在 Stack Overflow 上联系他们。

转到 Stack Overflow
发现错误或缺少功能?

AMP 项目强烈鼓励您的参与和贡献!我们希望您能成为我们开源社区的持续参与者,但我们也欢迎您为自己特别关注的问题做出一次性的贡献。

转到 GitHub