">文档:<amp-stream-gallery> - amp.dev - AMP 框架
AMP

amp-stream-gallery

实验性
Bento

描述

沿着水平轴同时显示多个类似的内容片段,用于相关产品或文章等功能。

 

必需脚本

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

用法

用于沿着水平轴同时显示多个类似内容片段的流媒体画廊。若要实现更定制的 UX,请参阅 amp-base-carousel

示例

在以下示例中,我们使用 amp-stream-gallery 在响应式容器中显示其内容,根据视口大小一次显示不同数量的子项。

<amp-stream-gallery width="7.5" height="2" layout="responsive">
  <amp-img src="img1.png" layout="flex-item"></amp-img>
  <amp-img src="img2.png" layout="flex-item"></amp-img>
  <amp-img src="img3.png" layout="flex-item"></amp-img>
  <amp-img src="img4.png" layout="flex-item"></amp-img>
  <amp-img src="img5.png" layout="flex-item"></amp-img>
  <amp-img src="img6.png" layout="flex-item"></amp-img>
  <amp-img src="img7.png" layout="flex-item"></amp-img>
</amp-stream-gallery>

amp-stream-gallery 组件的每个直接子项都被视为画廊中的一个项目。这些节点中的每一个也可能具有任意 HTML 子项。

画廊由任意数量的项目组成,以及可选的导航箭头,可按给定的项目数量向前或向后移动。

如果用户滑动或使用可自定义的箭头按钮,画廊将在项目之间前进。

在有效的 AMP 文档之外独立使用

Bento 允许你在非 AMP 页面中使用 AMP 组件,而无需完全符合 AMP。你可以获取这些组件,并将它们放置在不支持 AMP 的框架和 CMS 中的实现中。在我们的指南 在非 AMP 页面中使用 AMP 组件 中阅读更多内容。

要查找 amp-stream-gallery 的独立版本,请参阅 bento-stream-gallery

用户应注意的行为

幻灯片布局

幻灯片由轮播自动调整大小。你应该给幻灯片 layout="flex-item"

<amp-stream-gallery >
  <amp-img layout="flex-item" src="…"></amp-img>
</amp-stream-gallery>

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

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

属性

媒体查询

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

行为

控件

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

  • always:始终显示箭头。
  • auto:当轮播最近通过鼠标收到交互时显示箭头,当轮播最近通过触摸收到交互时不显示箭头。在触摸设备上首次加载时,箭头会显示,直到首次交互。
  • never:从不显示箭头。

额外空间

"around" 或未定义。这决定了在显示轮播中计算出的可见幻灯片数量后如何分配额外的空间。如果为 "around",则空白空间在轮播周围均匀分布,其中 justify-content: center;否则,空间分配给 LTR 文档的轮播右侧,分配给 RTL 文档的轮播左侧。

循环

truefalse,默认为 true。当为 true 时,旋转木马会允许用户从第一个项目返回到最后一个项目,反之亦然。必须至少存在三张幻灯片才能进行循环。

外置箭头

truefalse,默认为 false。当为 true 时,旋转木马会显示其箭头,并位于幻灯片的任一侧。请注意,对于外置箭头,幻灯片容器的有效长度将比其给定容器分配的空间少 100px - 每一侧的箭头 50px。当为 false 时,旋转木马会显示其箭头,并将其插入并覆盖在幻灯片的左右边缘上。

预览

一个数字,默认为 0。这决定了显示多少额外的幻灯片(在当前幻灯片的一侧或两侧),作为一种提示,表明旋转木马是可以滑动的。

通用属性

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

最小可见数量

一个数字,默认为 1。确定给定时间应该显示的幻灯片的最小数量。可以使用分数值使部分附加幻灯片可见。

最大可见数量

一个数字,默认为 Number.MAX_VALUE。确定给定时间应该显示的幻灯片的最大数量。可以使用分数值使部分附加幻灯片可见。

最小项目宽度

一个数字,默认为 1。确定每个项目的最小宽度,用于确定在画廊的整体宽度内一次可以显示多少个完整项目。

最大项目宽度

一个数字,默认为 Number.MAX_VALUE。确定每个项目的最大宽度,用于确定在画廊的整体宽度内一次可以显示多少个完整项目。

幻灯片捕捉

幻灯片对齐

startcenter。当开始对齐时,幻灯片的开始(例如,水平对齐时的左边缘)与旋转木马的开始对齐。当居中对齐时,幻灯片的中心与旋转木马的中心对齐。

捕捉

truefalse,默认为 true。确定滚动时旋转木马是否应该在幻灯片上捕捉。

操作

下一个

将轮播向前移动已计算的可见幻灯片数量。

上一个

将轮播向后移动已计算的可见幻灯片数量。

转到幻灯片

将轮播移动到由index参数指定的幻灯片。

活动

幻灯片更改

当轮播显示的索引发生更改时触发此事件。可以通过event.index获得新索引。

样式

你可以使用amp-stream-gallery元素选择器自由设置轮播样式。

自定义箭头按钮

可以通过传入你自己的自定义标记来自定义箭头按钮。例如,你可以使用以下 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-stream-gallery >
  <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-stream-gallery>

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

  <amp-stream-gallery id="carousel-1" ><div slot="next-arrow"></div>
    <div slot="prev-arrow"></div>
  </amp-stream-gallery>
  <button on="tap:carousel-1.prev()">Previous</button>
  <button on="tap:carousel-1.next()">Next</button>
需要更多帮助吗?

你已经阅读了本文档十几次,但它并没有真正涵盖你所有的问题?也许其他人也有同样的感觉:在 Stack Overflow 上联系他们。

转到 Stack Overflow
发现了一个错误或缺少功能?

AMP 项目强烈鼓励你参与和贡献!我们希望你成为我们开源社区的持续参与者,但我们也欢迎针对你特别热衷的问题进行一次性贡献。

转到 GitHub