amp-base-carousel

1.0 0.1

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

用法

用于沿水平轴或垂直轴显示多段相似内容的通用轮播。

amp-base-carousel 组件的每个直接子项都被视为轮播中的一个项目。这些节点中的每一个也可能具有任意 HTML 子项。

轮播包含任意数量的项目，以及可选的导航箭头，用于向前或向后移动单个项目。

如果用户滑动或使用可自定义的箭头按钮，轮播会在项目之间前进。

属性

媒体查询

<amp-base-carousel> 的属性可以配置为根据 媒体查询 使用不同的选项。

配置选项

可见幻灯片数

mixed-length

true 或 false，默认为 false。为 true 时，对每个幻灯片使用现有的宽度（或水平方向时的宽度）。这允许使用具有不同宽度的幻灯片的轮播。

visible-count

一个数字，默认为 1。确定给定时间应显示多少个幻灯片。可以使用分数值使部分附加幻灯片可见。当 mixed-length 为 true 时，将忽略此选项。

advance-count

一个数字，默认为 1。确定使用上一个或下一个箭头前进时，轮播将前进多少个幻灯片。在指定 visible-count 属性时，这很有用。

自动前进

auto-advance

true 或 false，默认为 false。根据延迟自动将轮播前进到下一张幻灯片。如果用户手动更改幻灯片，则自动前进将停止。请注意，如果未启用 loop，则在到达最后一个项目时，自动前进将向后移动到第一个项目。

auto-advance-count

一个数字，默认为 1。确定自动前进时，轮播将前进多少个幻灯片。在指定 visible-count 属性时，这很有用。

auto-advance-interval

一个数字，默认为 1000。指定轮播后续自动前进之间的毫秒数。

auto-advance-loops

一个数字，默认为 ∞。轮播在停止之前应在幻灯片中前进的次数。

捕捉

snap

true 或 false，默认为 true。确定滚动时轮播是否应在幻灯片上捕捉。

snap-align

start 或 center。当开始对齐时，幻灯片的开始（例如，水平对齐时的左边缘）与轮播的开始对齐。当居中对齐时，幻灯片的中心与轮播的中心对齐。

snap-by

一个数字，默认为 1。这决定了捕捉的粒度，并且在使用 visible-count 时很有用。

其他

controls

"always"、"auto" 或 "never"，默认为 "auto"。这决定了是否以及何时显示上一个/下一个导航箭头。注意：当 outset-arrows 为 true 时，箭头始终显示为 "always"。

• always：始终显示箭头。
• auto：当最近一次与旋转木马的交互是通过鼠标进行时，箭头显示，而当最近一次与旋转木马的交互是通过触摸进行时，箭头不显示。对于触摸设备，在首次交互之前，箭头会显示。
• never：永远不显示箭头。

slide

一个数字，默认为 0。这决定了旋转木马中显示的初始幻灯片。这可以与 amp-bind 一起使用，以控制当前显示哪个幻灯片。

loop

true 或 false，省略时默认为 false。为 true 时，旋转木马将允许用户从第一项返回到最后一项，反之亦然。必须至少有 visible-count 的三倍幻灯片才能循环。

horizontal

true 或 false，默认为 true。为 true 时，旋转木马将水平布局，用户可以左右滑动。为 false 时，旋转木马将垂直布局，用户可以上下滑动。

通用属性

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

操作

next

将旋转木马向前移动 advance-count 张幻灯片。

prev

将旋转木马向后移动 advance-count 张幻灯片。

goToSlide

将旋转木马移动到 index 参数指定的幻灯片。

活动

slideChange

当旋转木马显示的索引发生变化时，触发此事件。可以通过 event.index 获取新索引。

样式

你可以使用 amp-base-carousel 元素选择器自由地设置旋转木马的样式。

自定义箭头按钮

可以通过传入你自己的自定义标记来自定义箭头按钮。例如，你可以使用以下 HTML 和 CSS 来重新创建默认样式

.carousel-prev,
.carousel-next {
  filter: drop-shadow(0px 1px 2px #4a4a4a);
  width: 40px;
  height: 40px;
  padding: 20px;
  background-color: transparent;
  border: none;
  outline: none;
}

.carousel-prev {
  background-image: url('data:image/svg+xml;charset=utf-8,<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path  d="M14,7.4 L9.4,12 L14,16.6" fill="none" stroke="#fff" stroke-width="2px" stroke-linejoin="round" stroke-linecap="round" /></svg>');
}

.carousel-next {
  background-image: url('data:image/svg+xml;charset=utf-8,<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path  d="M10,7.4 L14.6,12 L10,16.6" fill="none" stroke="#fff" stroke-width="2px" stroke-linejoin="round" stroke-linecap="round" /></svg>');
}

<amp-base-carousel …>
  <div>first slide</div>
  …
  <button slot="next-arrow" class="carousel-next" aria-label="Next"></button>
  <button
    slot="prev-arrow"
    class="carousel-prev"
    aria-label="Previous"
  ></button>
</amp-base-carousel>

如果你想对箭头按钮进行更多自定义，可以使用 next 和 prev 操作。例如，如果你想将按钮放在旋转木马下方，并使用“上一个”和“下一个”字样，而不是将它们放在默认位置，可以使用以下 HTML

  <amp-base-carousel id="carousel-1" …>
    …
    <div slot="next-arrow"></div>
    <div slot="prev-arrow"></div>
  </amp-carousel>
  <button on="tap:carousel-1.prev()">Previous</button>
  <button on="tap:carousel-1.next()">Next</button>

使用说明

RTL

<amp-base-carousel> 目前要求你在它处于从右到左 (rtl) 的上下文中（例如阿拉伯语、希伯来语页面）时告知它。虽然旋转木马通常可以在没有这种情况时工作，但可能存在一些错误。你可以通过以下方式让旋转木马知道它应作为 rtl 运行

<amp-base-carousel dir="rtl" …>
  …
</amp-base-carousel>

如果旋转木马处于 RTL 上下文中，并且你希望旋转木马作为 LTR 运行，则可以在旋转木马上明确设置 dir="ltr"。

幻灯片布局

不指定 mixed-lengths 时，幻灯片会自动按旋转木马的大小调整。你应该给幻灯片 layout="flex-item"

<amp-base-carousel …>
  <amp-img layout="flex-item" src="…"></amp-img>
</amp-base-carousel>

当轮播以水平方式布局时，幻灯片的默认高度为 100%。这可以通过 CSS 或使用 layout="fixed-height" 轻松更改。指定高度时，幻灯片将在轮播内垂直居中。

如果您想水平居中幻灯片内容，您将需要创建一个包装元素，并使用它来居中内容。

可见幻灯片数

当使用 visible-slides 更改可见幻灯片数量时，为了响应媒体查询，您可能希望更改轮播本身的纵横比，以匹配新的可见幻灯片数量。例如，如果您想一次显示三张幻灯片，纵横比为一比一，那么您希望轮播本身的纵横比为三比一。类似地，一次显示四张幻灯片，您希望纵横比为四比一。此外，当更改 visible-slides 时，您可能希望更改 advance-count。

<!-- Using an aspect ratio of 3:2 for the slides in this example. -->
<amp-base-carousel
  layout="responsive"
  width="3"
  height="1"
  heights="(min-width: 600px) calc(100% * 4 * 3 / 2), calc(100% * 3 * 3 / 2)"
  visible-count="(min-width: 600px) 4, 3"
  advance-count="(min-width: 600px) 4, 3"
>
  <amp-img layout="flex-item" src="…"></amp-img>
  …
</amp-base-carousel>

验证

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