AMP Conf 2020: Save the date!
AMP
  • email

amp-list

Introduction

The amp-list enables client-side rendering in AMP. Content can either be fetched from a JSON endpoint or locally from amp-state.

Setup

Import the amp-list component ...

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

... and the amp-mustache component in the header.

<script async custom-template="amp-mustache" src="https://cdn.ampproject.org/v0/amp-mustache-0.2.js"></script>

Import the amp-bind component for dynamically changing the content of an amp-list.

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

Basic usage

The amp-list content is provided by a JSON CORS endpoint, which is defined by the src attribute. The URL's protocol must be HTTPS. The response must be a JSON object containing an array property items, for example:

{
  "items": [
    {
      "title": "amp-carousel",
      "url": "https://ampbyexample.com/components/amp-carousel"
    },
    ...
  ]
}

The list content is rendered via an amp-mustache template. The template can be specified either by id, or by using a nested element. For performance reasons, we're adding binding="no" as we're not using amp-bind.

<amp-list layout="fixed-height"
  height="100"
  src="https://amp.dev/static/samples/json/examples.json"
  binding="no">
  <template type="amp-mustache">
    <div><a href="{{url}}">{{title}}</a></div>
  </template>
</amp-list>

Re-using an existing template

The template can also be specified using an ID of an existing template element.

<template type="amp-mustache"
  id="amp-template-id">
  <div><a href="{{url}}">{{title}}</a></div>
</template>
<amp-list layout="fixed-height"
  height="100"
  src="https://amp.dev/static/samples/json/examples.json"
  template="amp-template-id"
  binding="no">
</amp-list>

Handling list overflow

If the amp-list content requires more space than available, the AMP runtime will display the overflow element (if specified).

Show more
<amp-list layout="fixed-height"
  height="48"
  src="https://amp.dev/static/samples/json/examples.json"
  binding="no">
  <div overflow
    role="button"
    aria-label="Show more"
    class="list-overflow">
    Show more
  </div>
  <template type="amp-mustache">
    <div><a href="{{url}}">{{title}}</a></div>
  </template>
</amp-list>

Using a placeholder

You can use a custom placeholder that looks similar to the rendered items to improve the user experience while the list is loading. We are using an endpoint which intentionally delays the response by 10 seconds.

Loading...
Loading...
Loading...
<amp-list id="amp-list-placeholder"
  noloading
  layout="fixed-height"
  height="654"
  src="https://amp.dev/documentation/examples/api/slow-json-with-items/?delay=10000"
  binding="no">
  <div placeholder>
    <div class="product">
      <div class="image-placeholder"></div>
      <div>Loading...</div>
    </div>
    <div class="product">
      <div class="image-placeholder"></div>
      <div>Loading...</div>
    </div>
    <div class="product">
      <div class="image-placeholder"></div>
      <div>Loading...</div>
    </div>
  </div>
  <template type="amp-mustache">
    <div class="product">
      <amp-img width="150"
        height="100"
        alt="{{name}}"
        src="{{img}}"></amp-img>
      <div>
        <div>{{name}}</div>
        <div>{{{stars}}}</div>
        <div>${{price}}</div>
      </div>
    </div>
  </template>
</amp-list>
Need further explanation?

If the explanations on this page don't cover all of your questions feel free to reach out to other AMP users to discuss your exact use case.

Go to Stack Overflow
An unexplained feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Edit sample on GitHub