amp-sidebar

您现在可以使用此组件的 Bento 版本在有效的 AMP 文档外部使用此组件。在 Bento 指南中了解详情。

说明

提供一种方法来显示用于临时访问的元内容，例如导航、链接、按钮、菜单。

必需脚本

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

支持的布局

nodisplay

示例

amp-sidebar 产品浏览页面产品页面

用法

提供一种方法来显示用于临时访问的元内容，例如导航、链接、按钮、菜单。轻触按钮即可显示侧边栏，同时主内容在下方保持可见。

<amp-sidebar> 隐藏用于临时访问的元内容（导航链接、按钮、菜单等）。可以通过轻触按钮打开和关闭 <amp-sidebar>，也可以在 amp-sidebar 外部轻触。但是，可以将接受媒体查询的可选属性用于在网站的其他部分显示元内容。子 <nav toolbar="(媒体查询)" toolbar-target="elementID"> 元素允许侧边栏内的内容显示在主内容的其他部分。

侧边栏只能显示在页面的左侧或右侧。
<amp-sidebar> 可能包含任何有效的 HTML 元素（受 AMP 支持）。
<amp-sidebar> 可能包含以下任何 AMP 元素
- <amp-accordion>
- <amp-img>
- <amp-fit-text>
- <amp-list>
- <amp-live-list>
- <amp-social-share>
侧边栏的最大高度为 100vh，如果高度超过 100vh，则会显示垂直滚动条。默认高度在 CSS 中设置为 100vh，并且可以在 CSS 中覆盖。
可以使用 CSS 设置和调整侧边栏的宽度（最小宽度为 45px）。
当侧边栏打开时，将禁用 amp-sidebar 及其蒙版的触控缩放。
建议将<amp-sidebar>作为<body>的直接子元素，以保持合乎逻辑的 DOM 顺序（便于访问），并避免容器元素改变其行为。请注意，如果amp-sidebar的祖先元素设置了z-index，则侧边栏可能会显示在其他元素（例如页眉）下方，从而破坏其功能。

示例

在以下示例中，我们使用amp-sidebar包含导航项。但是，第二个和第四个项目（导航项 2 和导航项 4）被分配到页面上的元素 ID。通过使用on属性，我们可以使用元素 ID 和scrollTo平滑滚动到元素。

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>
</amp-sidebar>

要在点击或单击元素时切换、打开或关闭侧边栏，请在元素上设置on操作属性，并指定以下操作方法之一

操作	说明
open（默认）	打开侧边栏
close	关闭侧边栏
toggle	切换侧边栏状态

如果用户点击部分可见的主内容区域，则会关闭侧边栏。

或者，按键盘上的 Escape 键也会关闭侧边栏。

示例

<button class="hamburger" on="tap:sidebar1.toggle"></button>
<button on="tap:sidebar1">Open</button>
<button on="tap:sidebar1.open">Open</button>
<button on="tap:sidebar1.close">x</button>

您可以通过指定toolbar属性（带有媒体查询）和toolbar-target属性（带有元素 ID，在<nav>元素上，该元素是<amp-sidebar>的子元素）来创建显示在<body>中的toolbar元素。toolbar复制<nav>元素及其子元素，并将元素追加到toolbar-target元素中。

行为

侧边栏可以通过添加带有toolbar属性和toolbar-target属性的导航元素来实现工具栏。
导航元素必须是<amp-sidebar>的子元素，并遵循以下格式：<nav toolbar="(media-query)" toolbar-target="elementID">。
- 例如，这将是工具栏的有效用法：<nav toolbar="(max-width: 1024px)" toolbar-target="target-element">。
包含工具栏属性的导航只能包含一个<ul>或<ol>元素，其中包含<li>元素。
- <li>元素可以包含任何有效的 HTML 元素（受 AMP 支持），或<amp-sidebar>支持的任何 AMP 元素。
工具栏行为仅在toolbar属性媒体查询有效时才应用。此外，页面上必须存在具有toolbar-target属性 ID 的元素，才能应用工具栏。

示例：基本工具栏

在以下示例中，如果窗口宽度小于或等于 767px，我们将显示一个 toolbar。toolbar 包含一个搜索输入元素。toolbar 元素将附加到 <div id="target-element"> 元素。

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>

  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>
        <input placeholder="Search..." />
      </li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element"></div>

<amp-sidebar> 元素内的 toolbar 元素将根据 toolbar-target 元素是显示还是隐藏，对元素应用类。这对于对 toolbar 元素应用不同的样式，然后对 toolbar-target 元素应用不同的样式非常有用。这些类是 amp-sidebar-toolbar-target-shown 和 amp-sidebar-toolbar-target-hidden。当 toolbar-target 元素显示时，类 amp-sidebar-toolbar-target-shown 应用于 toolbar 元素。当 toolbar-target 元素隐藏时，类 amp-sidebar-toolbar-target-hidden 应用于 toolbar 元素。此外，可以通过 amp-sidebar-mask 自定义遮罩的不透明度。

示例：工具栏状态类

在以下示例中，如果窗口宽度小于或等于 767px，我们将显示一个 toolbar。toolbar 包含一个搜索输入元素。toolbar 元素将附加到 <div id="target-element"> 元素。但是，当 <div id="toolbar-target"> 元素显示时，我们添加了一些自定义样式来隐藏 toolbar 元素。

<style amp-custom="">
  .amp-sidebar-toolbar-target-shown {
    display: none;
  }
</style>

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <ul>
    <li>Nav item 1</li>
    <li><a href="#idTwo" on="tap:idTwo.scrollTo">Nav item 2</a></li>
    <li>Nav item 3</li>
    <li><a href="#idFour" on="tap:idFour.scrollTo">Nav item 4</a></li>
    <li>Nav item 5</li>
    <li>Nav item 6</li>
  </ul>

  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>
        <input placeholder="Search..." />
      </li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element"></div>

在溢出区域内自动滚动

amp-sidebar 可以自动滚动溢出的容器到在侧边栏和工具栏案例中都用 autoscroll 作为属性装饰的第一元素。

在处理较长的导航列表并希望侧边栏在页面加载时滚动到当前导航项时，此功能非常有用。

使用 toolbar 功能时，仅当 <nav toolbar> 元素设置为 overflow: auto 或 overflow: scroll 时，autoscroll 才有效。

<style amp-custom="">
  nav [toolbar] {
    overflow: auto;
  }
</style>

<amp-sidebar id="sidebar1" layout="nodisplay" side="right">
  <nav toolbar="(max-width: 767px)" toolbar-target="target-element">
    <ul>
      <li>Nav item 1</li>
      <li>Nav item 2</li>
      <li>Nav item 3</li>
      <li autoscroll class="currentPage">Nav item 4</li>
      <li>Nav item 5</li>
      <li>Nav item 6</li>
    </ul>
  </nav>
</amp-sidebar>

<div id="target-element"></div>

请参阅此示例文件，了解可用的示例代码。

构建嵌套菜单

<amp-sidebar> 通过名为 <amp-nested-menu> 的子组件支持钻取（嵌套）菜单。使用 <amp-nested-menu>，<amp-sidebar> 可以支持嵌套一层或多层子菜单（并在它们之间进行转换），如下面的示例所示

使用 amp-nested-menu 时，将每个菜单项包装在 li 元素中以提高可访问性和键盘支持。

<button on="tap:sidebar1">Open Sidebar</button>
<amp-sidebar id="sidebar1" layout="nodisplay" style="width:300px">
  <amp-nested-menu layout="fill">
    <ul>
      <li>
        <h4 amp-nested-submenu-open>Open Sub-Menu</h4>
        <div amp-nested-submenu>
          <ul>
            <li>
              <h4 amp-nested-submenu-close>Go back</h4>
            </li>
            <li>
              <h4 amp-nested-submenu-open>Open Another Sub-Menu</h4>
              <div amp-nested-submenu>
                <h4 amp-nested-submenu-close>Go back</h4>
              </div>
            </li>
          </ul>
        </div>
      </li>
      <li>
        <a href="https://amp.org.cn/">Link</a>
      </li>
    </ul>
  </amp-nested-menu>
</amp-sidebar>

在游乐场中打开此代码段

请参阅 <amp-nested-menu>，了解有关嵌套菜单的完整文档以及动态内容加载等高级功能。

用户体验注意事项

在使用<amp-sidebar>时，请记住，用户通常会在 AMP 查看器中以移动设备查看你的页面，而该查看器可能会显示固定位置页眉。此外，浏览器通常会在页面顶部显示其自己的固定页眉。在屏幕顶部添加另一个固定位置元素会占用大量移动屏幕空间，而该空间的内容不会为用户提供任何新信息。

因此，我们建议不要将打开侧边栏的提示放置在固定全宽页眉中。

属性

side

指示侧边栏应从页面的哪一侧打开，left或right。如果未指定side，则side值将从body标签的dir属性继承（ltr => left，rtl => right）；如果不存在dir，则side默认为left。

布局

指定侧边栏的显示布局，该布局必须为nodisplay。

open

侧边栏打开时会显示此属性。

data-close-button-aria-label

可选属性，用于设置无障碍功能添加的关闭按钮的 ARIA 标签。

toolbar

此属性存在于子<nav toolbar="(media-query)" toolbar-target="elementID">元素中，并接受显示工具栏的媒体查询。有关使用工具栏的更多信息，请参阅工具栏部分。

此属性存在于子<nav toolbar="(media-query)" toolbar-target="elementID">中，并接受页面上元素的 ID。toolbar-target属性会将工具栏放置在页面上指定元素 ID 中，而不会使用默认工具栏样式。有关使用工具栏的更多信息，请参阅工具栏部分。

data-disable-swipe-close

在amp-sidebar上包含此属性会禁用滑动关闭。在使用移动设备或其他支持触控的设备时，将禁用滑动关闭侧边栏。

通用属性

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

样式

可以使用标准 CSS 对amp-sidebar组件进行样式设置。

可以设置amp-sidebar的width，以调整预设最小值 (45px) 和最大值 (80vw) 之间的宽度。
可以设置amp-sidebar的高度，以根据需要调整侧边栏的高度。如果高度超过 100vw，侧边栏将具有垂直滚动条。侧边栏的预设高度为 100vw，可以在 CSS 中覆盖它以使其更短。
侧边栏的当前状态通过 open 属性公开，当侧边栏在页面上打开时，该属性将设置在 amp-sidebar 标记上。

访问 AMP Start，了解如何在 AMP 页面中使用响应式预设导航菜单。

验证

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

需要更多帮助？

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

转到 Stack Overflow

发现了一个错误或缺少功能？

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

转到 GitHub

amp-sidebar 1.0 0.2 0.1

说明