amp-list

1.0 0.1

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

用法

amp-list 组件从 CORS JSON 端点提取动态内容。端点的响应包含数据，这些数据在指定的模板中呈现。

您可以通过以下两种方式之一指定模板

• 一个 template 属性，它引用现有模板元素的 ID。
• 一个直接嵌套在 amp-list 元素内的模板元素。

有关模板的更多详细信息，请参阅 AMP HTML 模板。

显示动态列表

在以下示例中，我们检索包含 URL 和标题的 JSON 数据，并在嵌套的 amp-mustache 模板中呈现内容。

<amp-list
  width="auto"
  height="100"
  layout="fixed-height"
  src="/static/inline-examples/data/amp-list-urls.json"
>
  <template type="amp-mustache">

    <div class="url-entry">
      <a href="{{url}}">{{title}}</a>
    </div>
  </template>
</amp-list>

这是我们使用的 JSON 文件

{
  "items": [
    {
      "title": "AMP YouTube Channel",
      "url": "https://www.youtube.com/channel/UCXPBsjgKKG2HqsKBhWA4uQw"
    },
    {
      "title": "AMPproject.org",
      "url": "https://www.ampproject.org/"
    },
    {
      "title": "AMP",
      "url": "https://amp.org.cn/"
    },
    {
      "title": "AMP Start",
      "url": "https://ampstart.com/"
    }
  ]
}

这是我们如何设置获取的内容的样式

amp-list div[role='list'] {
  display: grid;
  grid-gap: 0.5em;
}

请求始终从客户端发出，即使文档是从 AMP 缓存提供的。加载是根据元素与当前视口之间的距离，使用正常的 AMP 规则触发的。

如果 <amp-list> 在加载后需要更多空间，它会请求 AMP 运行时使用正常的 AMP 流更新其高度。如果 AMP 运行时无法满足新高度的请求，它将显示 overflow 元素（如果可用）。但是请注意，<amp-list> 元素通常放置在文档底部，几乎总是保证 AMP 运行时可以调整其大小。

amp-list 的辅助功能注意事项

默认情况下，<amp-list> 会向列表元素添加 list ARIA 角色，并向通过模板呈现的项目元素添加 listitem 角色。如果列表元素或其任何子元素不是“可制表”的（可通过键盘键（如 a 和 button 元素或任何具有正 tabindex 的元素）访问），则默认情况下会将 tabindex 设置为 0 添加到列表项。这种行为可以说并不总是合适的 - 通常，只有交互式控件/内容才应该是可聚焦的。如果您想禁止这种行为，请确保在模板的最外层元素中包含 tabindex="-1"。

<template type="amp-mustache">

  <div class="item">{{item}}</div>
  <div class="price">{{price}}</div>
</template>

<template type="amp-mustache">

  <div>
    <div class="item">{{item}}</div>
    <div class="price">{{price}}</div>
  </div>
</template>

XHR 批处理

AMP 会将 XMLHttpRequests (XHR) 批处理到 JSON 端点，也就是说，您可以将单个 JSON 数据请求用作 AMP 页面上多个消费者（例如，多个 <amp-list> 元素）的数据源。例如，如果您的 <amp-list> 向端点发出 XHR，则在 XHR 传输期间，所有后续向同一端点发出的 XHR 都不会触发，而是会返回第一个 XHR 的结果。

在 <amp-list> 中，您可以使用 items 属性来呈现 JSON 响应的子集，从而允许您拥有多个 <amp-list> 元素，这些元素呈现不同的内容，但共享单个 XHR。

指定溢出

（可选）<amp-list> 组件可以包含一个具有 overflow 属性的元素。如果满足以下所有条件，AMP 将显示此元素

• 呈现到 amp-list 中的内容超过其指定的大小。
• amp-list 的底部位于视口内。
• amp-list 的底部不在页面底部附近（定义为文档底部 15% 或底部 1000 像素的最小值）

如果 amp-list 在视口外，它将自动展开。

示例：当列表需要更多空间时显示溢出

在以下示例中，我们显示图像和标题的列表。由于 <amp-list> 内容需要比可用空间更多的空间，因此 AMP 框架会显示溢出元素。

<amp-list
  width="auto"
  height="140"
  layout="fixed-height"
  src="/static/inline-examples/data/amp-list-data.json"
>
  <template type="amp-mustache">

    <div class="image-entry">
      <amp-img src="{{imageUrl}}" width="100" height="75"></amp-img>
      <span class="image-title">{{title}}</span>
    </div>
  </template>
  <div overflow class="list-overflow" style="background-color:red;">
    See more
  </div>
</amp-list>

AMP 将以下 CSS 应用于具有 overflow 属性的元素

.list-overflow[overflow] {
  position: absolute;
  bottom: 0;
  left: 0;
  right: 0;
}

占位符和回退

（可选）<amp-list> 支持占位符和/或回退。

• 占位符 是具有 placeholder 属性的子元素。此元素会一直显示，直到 <amp-list> 成功加载。如果还提供了回退，则当 <amp-list> 加载失败时，占位符会被隐藏。
• 回退 是具有 fallback 属性的子元素。如果 <amp-list> 加载失败，则会显示此元素。

在 占位符和回退 中了解更多信息。请注意，子元素不能同时是占位符和回退。

<amp-list src="https://foo.com/list.json">
  <div placeholder>Loading ...</div>
  <div fallback>Failed to load data.</div>
</amp-list>

刷新数据

<amp-list> 元素公开了一个 refresh 操作，其他元素可以在 on="tap:..." 属性中引用该操作。

<button on="tap:myList.refresh">Refresh List</button>
<amp-list id="myList" src="https://foo.com/list.json">
  <template type="amp-mustache">
    <div>{{title}}</div>
  </template>
</amp-list>

动态调整大小

在某些情况下，我们可能需要 <amp-list> 在用户交互时调整大小。例如，当 <amp-list> 包含用户可以点击的 amp-accordion 时，当 <amp-list> 的内容由于绑定的 CSS 类而改变大小时，或者当 <amp-list> 内的项目数量由于绑定的 [src] 属性而改变时。changeToLayoutContainer 操作通过在触发此操作时将 amp 列表更改为 layout="CONTAINER" 来处理此问题。请参阅以下示例

<button on="tap:list.changeToLayoutContainer()">Show Grid</button>
<amp-list
  id="list"
  width="396"
  height="80"
  layout="responsive"
  src="/test/manual/amp-list-data.json?RANDOM"
>
  <template type="amp-mustache">
{{title}}  </template>
</amp-list>

从 amp-state 初始化

在大多数情况下，您可能需要 <amp-list> 从服务器请求 JSON。但是，<amp-list> 也可以使用您在 <amp-state> 中包含的 JSON，就在您的 HTML 中！这意味着无需额外的服务器调用即可进行渲染，但是，当然，如果您的页面是从 AMP 缓存提供的，则数据可能不是最新的。

以下是将 <amp-list> 从 <amp-state> 渲染的方法

1. 将 amp-bind 脚本添加到文档的 <head> 中。
2. 在您的 <amp-list> 的 src 属性中使用 amp-state: 协议，如下所示：<amp-list src="amp-state:localState">

请注意，<amp-list> 以相同的方式处理您的 JSON，无论是从服务器请求还是从状态变量中提取。所需的格式不会更改。

请参阅下面的完整示例，

<amp-state id="localState">
  <script type="application/json">
    {
      "items": [{"id": 1}, {"id": 2}, {"id": 2}]
    }
  </script>
</amp-state>
<amp-list src="amp-state:localState">
  <template type="amp-mustache">
    <li>{{id}}</li>
  </template>
</amp-list>

使用 amp-script 作为数据源

您可以将导出的 <amp-script> 函数用作 <amp-list> 的数据源。这使您可以灵活地组合和转换服务器响应，然后再移交给 <amp-list>。所需的格式是 <amp-script> ID 和函数名称，用句点分隔，例如 amp-script:id.functionName。

请参阅下面的示例

<!--
  See the [amp-script](https://amp.org.cn/documentation/components/amp-script/) documentation to setup the component and export your function>
-->
<amp-script id="dataFunctions" script="local-script" nodom></amp-script>
<script id="local-script" type="text/plain" target="amp-script">
  function getRemoteData() {
    return fetch('https://example.com')
      .then(resp => resp.json())
      .then(transformData)
  }
  exportFunction('getRemoteData', getRemoteData);
</script>

<!-- "exported-functions" is the <amp-script> id, and "getRemoteData" corresponds to the exported function. -->
<amp-list
  id="amp-list"
  width="auto"
  height="100"
  layout="fixed-height"
  src="amp-script:dataFunctions.getRemoteData"
>
  <template type="amp-mustache">
    <div>{{.}}</div>
  </template>
</amp-list>

加载更多和无限滚动

load-more 属性具有 manual 和 auto 选项，以实现分页和无限滚动。

<amp-list
  load-more="auto"
  src="https://my.rest.endpoint/"
  width="100"
  height="200"
>
  <template type="amp-mustache">
    // ...
  </template>
</amp-list>

有关工作示例，请参阅 test/manual/amp-list/infinite-scroll-1.amp.html 和 test/manual/amp-list/infinite-scroll-2.amp.html。

自定义加载更多元素

带有 load-more 属性的 <amp-list> 包含以下 UI 元素：一个加载更多按钮、一个加载器、一个加载失败元素，以及可选的用于标记列表末尾的结尾帽。可以通过提供带有以下属性的 <amp-list-load-more> 元素作为 <amp-list> 的子元素来自定义这些元素

load-more-button

具有 load-more-button 属性的 <amp-list-load-more> 元素，如果还有更多元素要加载，它将显示在列表末尾（对于手动加载更多）。单击此元素将触发一个获取操作，从 load-more-src 字段或与 load-more-bookmark 属性对应的数据返回的字段中加载更多元素。可以通过提供具有 load-more-button 属性的子元素的 <amp-list> 来自定义此元素。

无限滚动列表的辅助功能注意事项

使用无限滚动列表时请小心 - 如果列表后有任何内容（包括标准页脚或类似内容），用户将无法访问它，直到加载/显示所有列表项。这可能会使用户体验感到沮丧，甚至无法克服。请参阅 Adrian Roselli：所以你认为你构建了一个好的无限滚动。

示例

<amp-list
  load-more="manual"
  src="https://www.load.more.example.com/"
  width="400"
  height="800"
>
  ...
  <amp-list-load-more load-more-button>
    <!-- My custom see more button -->
    <button>See More</button>
  </amp-list-load-more>
</amp-list>

它可以通过 amp-mustache 进行模板化。

示例

<amp-list
  load-more="auto"
  width="100"
  height="500"
  src="https://www.load.more.example.com/"
>
  ...
  <amp-list-load-more load-more-button>
    <template type="amp-mustache">
      Showing {{#count}} out of {{#total}} items
      <button>Click here to see more!</button>
    </template>
  </amp-list-load-more>
</amp-list>

load-more-loading

此元素是一个加载器，如果用户到达列表末尾且内容仍在加载，或者由于单击 load-more-button 元素（当 <amp-list> 的新子元素仍在加载时）而显示。可以通过提供具有 load-more-loading 属性的子元素的 <amp-list> 来自定义此元素。示例如下

<amp-list
  load-more="auto"
  src="https://www.load.more.example.com/"
  width="400"
  height="800"
>
  ...
  <amp-list-load-more load-more-loading>
    <!-- My custom loader -->
    <svg>...</svg>
  </amp-list-load-more>
</amp-list>

load-more-failed

一个包含 load-more-failed 属性的 <amp-list-load-more> 元素，该元素包含一个具有 load-more-clickable 属性的按钮，如果加载失败，该按钮将显示在 <amp-list> 的底部。单击此元素将触发对失败 URL 的重新加载。可以通过提供具有 load-more-failed 属性的子元素的 <amp-list> 来自定义此元素。示例如下

<amp-list
  load-more="auto"
  src="https://www.load.more.example.com/"
  width="200"
  height="500"
>
  ...
  <amp-list-load-more load-more-failed>
    <button>Unable to Load More</button>
  </amp-list-load-more>
</amp-list>

在上面的示例中，整个 load-more-failed 元素都是可点击的。但是，此元素的常见模式是一个不可点击的常规“加载失败”元素，其中包含一个可点击的“重新加载”按钮。为了解决这个问题，您可以拥有一个带有包含 load-more-clickable 元素的按钮的通常不可点击的元素。例如

<amp-list
  load-more="auto"
  src="https://www.load.more.example.com/"
  width="200"
  height="500"
>
  ...
  <amp-list-load-more load-more-failed>
    <div>
      Here is some unclickable text saying sorry loading failed.
    </div>
    <button load-more-clickable>Click me to reload!</button>
  </amp-list-load-more>
</amp-list>

load-more-end

默认情况下不提供此元素，但是如果将包含 load-more-end 属性的 <amp-list-load-more> 元素作为子元素附加到 <amp-list>，则如果不再有任何项目，此元素将显示在 <amp-list> 的底部。此元素可以通过 amp-mustache 进行模板化。示例如下

<amp-list
  load-more="auto"
  src="https://www.load.more.example.com/"
  width="200"
  height="500"
>
  ...
  <amp-list-load-more load-more-end>
    <!-- Custom load-end element -->
    Congratulations! You've reached the end.
  </amp-list-load-more>
</amp-list>

替换

<amp-list> 允许所有标准的 URL 变量替换。有关详细信息，请参阅 替换指南。

例如

<amp-list src="https://foo.com/list.json?RANDOM"></amp-list>

可能会向类似 https://foo.com/list.json?0.8390278471201 的地址发出请求，其中 RANDOM 值在每次展示时随机生成。

属性

src（必需）

返回 JSON 的远程端点的 URL，该 JSON 将在此 <amp-list> 中呈现。src 属性有三种有效的协议。

1. https：这必须引用 CORS HTTP 服务。不支持不安全的 HTTP。
2. amp-state：用于从 <amp-state> 数据初始化。有关更多详细信息，请参阅 从 <amp-state> 初始化。
3. amp-script：用于将 <amp-script> 函数用作数据源。有关更多详细信息，请参阅 将 <amp-script> 用作数据源。

如果在 src URL 处获取数据失败，则 <amp-list> 会触发低信任的 fetch-error 事件。

如果存在 [src] 属性，则可以省略 src 属性。[src] 支持 URL 和非 URL 表达式值；有关详细信息，请参阅 amp-bind 元素特定属性文档中的 amp-list。

credentials

定义由 Fetch API 指定的 credentials 选项。

• 支持的值：omit、include
• 默认值：omit

要发送凭据，请传递 include 的值。如果设置此值，则响应必须遵循 AMP CORS 安全指南。

这是一个指定包含凭据以在列表中显示个性化内容的示例

<amp-list
  credentials="include"
  src="<%host%>/json/product.json?clientId=CLIENT_ID(myCookieId)"
>
  <template type="amp-mustache">
    Your personal offer: ${{price}}  </template>
</amp-list>

items

定义表达式以查找要在响应中呈现的数组。这是一个点分隔的表达式，它通过 JSON 响应的字段进行导航。默认情况下，<amp-list> 期望一个数组，可以使用 single-item 属性从对象加载数据。

• 默认值为 "items"。预期的响应：{items: [...]}。
• 如果响应本身是所需的数组，请使用值 "."。预期的响应是：[...]。
• 允许嵌套导航（例如，"field1.field2"）。预期的响应是：{field1: {field2: [...]}}。

当指定 items="items" 时（这是默认值），响应必须是包含名为 "items" 的数组属性的 JSON 对象

{
  "items": [...]
}

max-items

一个整数值，指定要呈现的项目数组的最大长度。如果返回值超过 max-items，则 items 数组将被截断为 max-items 项。

single-item

使 <amp-list> 将返回的结果视为单个元素数组。对象响应将被包装在一个数组中，因此 {items: {...}} 的行为将如同 {items: [{...}]}。

xssi-prefix

使 <amp-list> 在解析之前从获取的 JSON 中删除前缀。这对于包含类似 )]} 的 安全前缀以帮助防止跨站点脚本攻击的 API 非常有用。

例如，假设我们有一个 API 返回此响应

)]}{ "items": ["value"] }

我们可以指示 amp-list 删除安全前缀，如下所示

<amp-list xssi-prefix=")]}" src="https://foo.com/list.json"></amp-list>

reset-on-refresh

当列表的源通过 amp-bind 或 refresh() 操作刷新时，再次显示加载指示器和占位符。

默认情况下，这只会触发导致网络获取的刷新。要在所有刷新时重置，请使用 reset-on-refresh="always"。

binding

对于使用 <amp-list> 且也使用 amp-bind 的页面，控制是否阻止呈现已呈现的子项中绑定的评估（例如 [text]）。

为了获得更快的性能，我们建议使用 binding="no" 或 binding="refresh"。

• binding="no"：永远不阻止呈现 （最快）。
• binding="refresh"：不在初始加载时阻止呈现 （更快）。
• binding="always"：始终阻止呈现 （慢）。

如果未提供 binding 属性，则默认为 always。

[is-layout-container]

这是一个可绑定的属性，默认情况下应始终为 false。当通过 amp-bind 设置为 true 时，它会将 <amp-list> 的布局更改为 container。此属性对于处理 amp-list 的动态调整大小非常有用。

此属性不能默认为 true，原因与 <amp-list> 不支持布局 CONTAINER 的原因相同 — 它可能会导致首次加载时内容跳跃。

或者，也可以使用 changeToLayoutContainer 操作。

load-more

此属性接受两个值："auto" 或 "manual"。将此属性的值设置为 "manual" 将在 <amp-list> 的末尾显示一个“加载更多”按钮。将此属性的值设置为 "auto" 将导致 <amp-list> 自动加载更多元素，向下三个视口以实现无限滚动效果。

load-more-bookmark

此属性指定返回数据中的字段名称，该字段名称将提供要加载的下一个项目的 URL。如果未指定此属性，则 <amp-list> 期望 JSON 有一个 load-more-src 字段，该字段对应于要加载的下一个 URL。如果此字段被称为其他名称，则可以通过 load-more-bookmark 字段指定该字段的名称。例如，在以下示例有效负载中，我们将指定 load-more-bookmark="next"。

{ "items": [...], "next": "https://url.to.load" }

通用属性

此元素包括扩展到 AMP 组件的 通用属性。

验证

请参阅 AMP 验证器规范中的 amp-list 规则。