amp-date-countdown
描述
显示倒计时序列到指定日期。
必需脚本
<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 模板中指定的格式
格式 | 含义 |
---|---|
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} and {m} {minutes} and {s} {seconds} | 4 hours and 1 minutes and 45 seconds | - |
{d} {days} {h}:{mm} | 1 day 5:03 | - |
{d} {days} {h} {hours} {m} {minutes} | 50 days 5 hours 10 minutes | - |
{d} {days} {h} {hours} {m} {minutes} | 20 days 5 hours 10 minutes | - |
{h} {hours} {m} {minutes} | 240 hours 10 minutes | biggest-unit='hours' |
{d} {days} {h} {hours} {m} {minutes} | 50 天 5 小时 10 分钟 | locale='zh-cn' |
属性
您必须指定以下必需属性中的至少一个:end-date
、timeleft-ms
、timestamp-ms
、timestamp-seconds
。
结束日期
倒计时的 ISO 格式日期。例如,2020-06-01T00:00:00+08:00
时间戳毫秒
毫秒为单位的 POSIX 纪元值;假定为 UTC 时区。例如,timestamp-ms="1521880470000"
。
时间戳秒
秒为单位的 POSIX 纪元值;假定为 UTC 时区。例如,timestamp-seconds="1521880470"
。
剩余时间毫秒
以毫秒为单位的值,表示倒计时的剩余时间。例如,剩余 48 小时 timeleft-ms="172800000"
。
偏移秒(可选)
一个正数或负数,表示要从 end-date
中添加或减去的秒数。例如,offset-seconds="60"
会将 60 秒添加到结束日期。
结束时(可选)
指定当计时器达到 0 秒时是否停止。该值可以设置为 stop
(默认值)以指示计时器在 0 秒时停止,并且不会超过最终日期,或设置为 continue
以指示计时器在达到 0 秒后继续。
语言环境(可选)
每个计时器单位的国际化语言字符串。默认值为 en
(英语)。
支持的值
代码 | 语言 |
---|---|
de | 德语 |
en | 英语 |
es | 西班牙语 |
fr | 法语 |
id | 印度尼西亚语 |
it | 意大利语 |
ja | 日语 |
ko | 韩语 |
nl | 荷兰语 |
pt | 葡萄牙语 |
ru | 俄语 |
th | 泰语 |
tr | 土耳其语 |
vi | 越南语 |
zh-cn | 简体中文 |
zh-tw | 繁体中文 |
最大单位(可选)
允许 amp-date-countdown
组件根据指定的 biggest-unit
值计算时间差。例如,假设剩余 50 天 10 小时
,如果 biggest-unit
设置为 hours
,则结果显示剩余 1210 小时
。
- 支持的值:
days
、hours
、minutes
、seconds
- 默认值:
days
data-count-up(可选)
包含此属性以反转倒计时的方向,改为进行正向计数。这有助于显示自过去某个目标日期以来经过的时间。要继续倒计时,当目标日期在过去时,请务必包含带有 continue
值的 when-ended
属性。如果目标日期在未来,amp-date-countdown
将显示递减(朝 0 方向)的负值。
活动
amp-date-countdown
组件公开以下事件,你可以使用 AMP on 语法来触发
超时
当计时器超时时。要使此操作起作用,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 规则。
你已经读过本文档很多遍了,但它并没有真正涵盖你所有的问题?也许其他人也有同感:在 Stack Overflow 上联系他们。
转到 Stack Overflow 发现了一个错误或缺少一个功能?AMP 项目强烈鼓励你的参与和贡献!我们希望你成为我们开源社区的持续参与者,但我们也欢迎针对你特别热衷的问题进行一次性贡献。
转到 GitHub