Do you build things with AMP? Fill out the AMP Developer Survey!
AMP
  • email

amp-carousel

Introduction

The amp-carousel component allows displaying multiple similar pieces of content along a horizontal axis.

Setup

Import the carousel component in the header.

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

Basic Usage

Use type="carousel" to display a list of images as a continuous strip.

a sample image
<amp-carousel height="300"
  layout="fixed-height"
  type="carousel"
  role="region"
  aria-label="Basic usage carousel">
  <amp-img src="https://amp.dev/static/samples/img/image1.jpg"
    width="400"
    height="300"
    alt="a sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image2.jpg"
    width="400"
    height="300"
    alt="another sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image3.jpg"
    width="400"
    height="300"
    alt="and another sample image"></amp-img>
</amp-carousel>

Slides

Use type="slides" to display a list of images as slides.

<amp-carousel width="400"
  height="300"
  layout="responsive"
  type="slides"
  role="region"
  aria-label="type='slides' carousel">
  <amp-img src="https://amp.dev/static/samples/img/image1.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="a sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image2.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="another sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image3.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="and another sample image"></amp-img>
</amp-carousel>

Autoplay

The autoplay attribute (type="slides" only) advances the slide to the next slide without user interaction, by default it will advance a slide in 5000 millisecond intervals (5 seconds) and can be overridden by the delay attribute.

<amp-carousel width="400"
  height="300"
  layout="responsive"
  type="slides"
  autoplay
  delay="2000"
  role="region"
  aria-label="Carousel with autoplay">
  <amp-img src="https://amp.dev/static/samples/img/image1.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="a sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image2.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="another sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image3.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="and another sample image"></amp-img>
</amp-carousel>

Buttons

By default, carousel buttons use inlined SVGs as background-images.

You may override these with your own SVGs or images by using .amp-carousel-button-prev and .amp-carousel-button-next classes.

<amp-carousel id="custom-button"
  width="400"
  height="300"
  layout="responsive"
  type="slides"
  autoplay
  delay="2000"
  role="region"
  aria-label="Carousel with custom button styles">
  <amp-img src="https://amp.dev/static/samples/img/image1.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="a sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image2.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="another sample image"></amp-img>
  <amp-img src="https://amp.dev/static/samples/img/image3.jpg"
    width="400"
    height="300"
    layout="responsive"
    alt="and another sample image"></amp-img>
</amp-carousel>

Supported Contents

Each of these nodes may also have arbitrary HTML children.

This is a blue box.
This is a red box.
This is a green box.
<amp-carousel height="300"
  layout="fixed-height"
  type="slides"
  role="region"
  aria-label="Carousel with arbitrary HTML content">
  <div>
    <div class="blue-box">
      This is a blue box.
    </div>
  </div>
  <div>
    <div class="red-box">
      This is a red box.
    </div>
  </div>
  <div>
    <div class="green-box">
      This is a green box.
    </div>
  </div>
</amp-carousel>

A good use case for amp-carousel are image galleries, here are some examples.

需要进一步说明?

如果此页面上的说明未能涵盖您的所有问题,欢迎与其他 AMP 用户取得联系,讨论您的具体用例。

前往 Stack Overflow
一项无法解释的功能?

AMP 项目强烈鼓励您参与并做出贡献!我们希望您能成为我们开放源代码社区的持续参与者,但我们也欢迎您对所热衷问题做出一次性贡献。

编辑 GitHub 上的示例