amp-position-observer

描述

在用户滚动时监视视口中元素的位置，并分派可与其他 AMP 组件配合使用的事件。

必需的脚本

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

支持的布局

nodisplay

示例

滚动绑定效果的基础知识滚动到顶部

用法

amp-position-observer 组件监视用户滚动时元素在视口中的位置，并分派 enter、exit 和 scroll:<视口中位置百分比> 事件（低信任级别），可用于触发其他组件（例如，amp-animation）上的操作（仅限低信任操作）。

amp-position-observer 组件仅在与其他组件配合使用时有用，且本身不执行任何操作。

目前，amp-animation 和 AMP 中的几个视频播放器是唯一允许低信任事件触发其操作（例如，启动动画、在动画中寻找位置、暂停视频等）的组件。

滚动绑定的动画

amp-animation 组件公开了一个 seekTo 操作，该操作可以与 amp-position-observer 的 scroll 事件绑定，以实现滚动绑定动画。

示例：动画在用户滚动时旋转

想象一下一个动画，其中时钟的时针随着用户滚动页面而旋转。

<!-- An animation that rotates a clock hand 180 degrees. -->
<!--
   Note that we are NOT setting `trigger=visibility`
   since we will manually trigger the animation.
-->
<amp-animation id="clockAnim" layout="nodisplay">
  <script type="application/json">
    {
      "duration": "3s",
      "fill": "both",
      "direction": "alternate",
      "animations": [
        {
          "selector": "#clock-scene .clock-hand",
          "keyframes": [
            {"transform": "rotate(-180deg)"},
            {"transform": "rotate(0deg)"}
          ]
        }
      ]
    }
  </script>
</amp-animation>

<!-- The clock container -->
<div id="clock-scene">
  <!--
    Use amp-position-observer to tie the movement of the clock scene within
    the viewport to the timeline of the animation
  -->
  <amp-position-observer
    intersection-ratios="1"
    on="scroll:clockAnim.seekTo(percent=event.percent)"
    layout="nodisplay"
  >
  </amp-position-observer>
  <amp-img layout="responsive" width="2" height="1.5" src="./img/clock.jpg">
    <div class="clock-hand"></div>
  </amp-img>
</div>

基于视口中可见性开始/暂停的动画场景

amp-animation 组件还公开 start 和 pause 操作，这些操作可以与 amp-position-observer 的 enter 和 exit 事件绑定，以根据可见性控制动画何时启动/暂停。

amp-position-observer 组件公开各种可见性配置，例如 intersection-ratios 和 viewport-margins（类似于 IntersectionObserver），可用于微调何时将目标视为可见。

示例：动画基于可见性开始和暂停

考虑相同的时钟动画，但这一次指针随着时间而移动，只是我们希望动画在时钟至少可见 50% 时启动，并在时钟可见度低于 50% 时立即暂停。

<!-- An animation that rotates a clock hand 180 degrees. -->
<!--
   Note that we are NOT setting `trigger=visibility`
   since we will manually trigger the animation
-->
<!--
   Also note that this is the same animation as the scroll-bound version above
   the animation is the same, just the triggering mechanism with
   `amp-position-observer` is different!
-->
<amp-animation id="clockAnim" layout="nodisplay">
  <script type="application/json">
    {
      "duration": "3s",
      "fill": "both",
      "direction": "alternate",
      "animations": [
        {
          "selector": "#clock-scene .clock-hand",
          "keyframes": [
            {"transform": "rotate(-180deg)"},
            {"transform": "rotate(0deg)"}
          ]
        }
      ]
    }
  </script>
</amp-animation>

<!-- The clock container -->
<div id="clock-scene">
  <!--
    Use amp-position-observer to tie the start/pause of the animation with
    the visibility of the scene.
  -->
  <amp-position-observer
    intersection-ratios="0.5"
    on="enter:clockAnim.start;exit:clockAnim.pause"
    layout="nodisplay"
  >
  </amp-position-observer>

  <amp-img layout="responsive" width="2" height="1.5" src="./img/clock.jpg">
    <div class="clock-hand"></div>
  </amp-img>
</div>

滚动绑定和基于可见性的动画的可访问性考虑因素

对于某些用户群体来说，动画通常会带来问题。滚动绑定和视差动画尤其可能对患有前庭疾病的用户造成问题。请务必查看 amp-animation 的无障碍性注意事项中提供的建议。

属性

target（可选）

指定要观察的元素的 ID。如果未指定，则使用 <amp-position-observer> 的父级 < 作为目标。

intersection-ratios（可选）

定义在 <amp-position-observer> 触发任何事件之前，目标在视口中应可见的比例。该值介于 0 到 1 之间（默认值为 0）。

您可以通过提供两个值（<top> <bottom>）为顶部和底部指定不同的比例。

`intersection-ratios="0"` 表示当目标的单个像素进入视口时，就会触发 `enter`，当目标的最后一个像素离开视口时，就会触发 `exit`。
`intersection-ratios="0.5"` 表示当目标的 50% 进入视口时，就会触发 `enter`，当目标不到 50% 在视口内时，就会触发 `exit`。
`intersection-ratios="1"` 表示当目标完全可见时，就会触发 `enter`，当单个像素离开视口时，就会触发 `exit`。
`intersection-ratios="0 1"` 根据目标是从顶部进入/退出（将使用 0）还是从底部进入/退出（将使用 1）来设置不同的条件。

viewport-margins（可选）

可以使用 px 或 vh 值来缩小用于可见性计算的视口区域。没有单位的数字将被视为 px。默认为 0。

您可以通过提供两个值（<top> <bottom>）为顶部和底部指定不同的值。

`viewport-margins="100px"` 表示从顶部缩小视口 100px，从底部缩小 100px。
`viewport-margins="25vh"` 表示从顶部缩小视口 25%，从底部缩小 25%。实际上只考虑视口的中间 50%。
`viewport-margins="100px 10vh"` 表示从顶部缩小视口 100px，从底部缩小 10%。

once（可选）

仅触发一次 enter 和 exit 事件。scroll 事件也只执行一次迭代。

属性的存在表示 true 值，属性的缺失表示 false 值。如果属性存在，则其值必须为空字符串、once 或未分配。

验证

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

需要更多帮助？

您已经阅读了本文档十几次，但它并没有真正涵盖您的所有问题？也许其他人也有同感：在 Stack Overflow 上联系他们。

转到 Stack Overflow

发现了一个 bug 或缺少某个功能？

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

转到 GitHub