Codelab:构建 Sidenav 组件

此 Codelab 将教您如何在 Web 上构建自适应滑出式侧边导航布局组件。我们将逐步构建该组件,首先是 HTML,然后是 CSS,最后是 JavaScript。

请参阅我的博文构建 Sidenav 组件,了解为构建此组件而选择的 CSS Web 平台功能。

设置

  1. 点击 Remix to Edit(混剪以编辑)使项目可编辑。
  2. 打开 app/index.html。

HTML

首先,了解 HTML 设置的基本要素,以便有内容和一些框可供使用。

将以下 HTML 放入 <body> 标记中。

<aside></aside>
<main></main>

<aside> 包含导航菜单,作为 <main> 的补充元素,后者包含主要页面内容。

接下来,我们将使用网页的其余内容填充这些语义元素。

在 <aside> 元素内添加一个导航元素、一些导航链接和一个关闭链接。

<aside>
  <nav>
    <h4>My</h4>
    <a href="#">Dashboard</a>
    <a href="#">Profile</a>
    <a href="#">Preferences</a>
    <a href="#">Archive</a>

    <h4>Settings</h4>
    <a href="#">Accessibility</a>
    <a href="#">Theme</a>
    <a href="#">Admin</a>
  </nav>

  <a href="#"></a>
</aside>

链接非常适合放在 <nav> 元素中,而 <nav> 元素非常适合放在 <aside> 边栏中。 不过,我们仍有改进的空间。

在主要内容元素中,添加一个页眉和一篇文章,以在语义上容纳布局内容。

<main>
  <header>
    <a href="#sidenav-open" class="hamburger">
      <svg viewBox="0 0 50 40">
        <line x1="0" x2="100%" y1="10%" y2="10%" />
        <line x1="0" x2="100%" y1="50%" y2="50%" />
        <line x1="0" x2="100%" y1="90%" y2="90%" />
      </svg>
    </a>
    <h1>Site Title</h1>
  </header>

  <article>
    {put some placeholder content here}
  </article>
</main>

标题中包含菜单打开链接。aside 元素包含关闭按钮。 稍后,我们将根据视口大小显示和隐藏元素。

在 <article> 元素中,我们粘贴了一个占位符句子。将“<lorem>”替换为您自己的内容,或粘贴下面提供的 lorem:

<h2>Totam Header</h2>
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Cum consectetur, necessitatibus velit officia ut impedit veritatis temporibus soluta? Totam odit cupiditate facilis nisi sunt hic necessitatibus voluptatem nihil doloribus! Enim.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

<h3>Subhead Totam Odit</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

<h3>Subhead</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

当此内容及其长度超出视口高度时,页面将可滚动。

到目前为止,您已经添加了一个 aside 元素,其中包含 nav、链接和关闭侧边导航栏的方法。 您还添加了标题、打开侧边栏的方法以及主元素中的文章。 这已经很简洁、语义化且经久不衰了,但我们可以让它对人人皆宜。侧边栏中的打开链接可以更清晰地标记。

向标头打开 link 元素添加属性 title 和 aria-label:

<a href="#sidenav-open" class="hamburger">
<a href="#sidenav-open" title="Open Menu" aria-label="Open Menu" class="hamburger">

打开 SVG 图标也可以更清晰地标记。 在 open link 元素内的 SVG 中添加以下属性:

<svg viewBox="0 0 50 40">
<svg viewBox="0 0 50 40" role="presentation" focusable="false" aria-label="trigram for heaven symbol">

侧边栏中的关闭链接可以更清晰地标记。 向侧边栏导航关闭 link 元素添加 title 和 aria-label 属性:

<a href="#"></a>
<a href="#" title="Close Menu" aria-label="Close Menu"></a>

CSS

现在可以开始布局元素了。主要内容和侧边导航栏是 <body> 标记的直接子级,因此这是一个很好的切入点。

将以下 CSS 添加到 css/sidenav.css 中,以便 <body> 元素布局子元素。

body {
  display: grid;
  grid: [stack] 1fr / min-content [stack] 1fr;

  @media (max-width: 540px) {
    & > :matches(aside, main) {
      grid-area: stack;
    }
  }
}

此布局基本上表示:创建一个名为 stack 的行,其中包含所有内容,该行中有 2 列,第 2 列也名为 stack。第 1 列的大小应根据其最小内容需求确定,第 2 列可以占据其余空间。 然后,如果视口受限,宽度不超过 540px,则将侧边导航栏和主要内容元素放入同一行和同一列,使它们在 1x1 网格中相互重叠。

有了这种自适应堆叠功能作为基础,我们现在可以利用网址栏的状态来切换侧边导航栏的可见性和过渡样式。

在 app/index.html 中更新 <aside> 元素:

<aside>
<aside id="sidenav-open">

这样,CSS 就可以将元素和网址哈希匹配在一起。这对于 :target 的使用非常重要。 现在,元素的 ID 可以与我们将使用 <a> 标记设置的网址哈希值匹配。

此外,为了更轻松地进行 JavaScript 定位,请为控制侧边栏导航的关键元素添加 ID。首先,向侧边栏打开链接添加一个 ID:

<a href="#sidenav-open" class="hamburger" title="Open Menu" aria-label="Open Menu">
<a href="#sidenav-open" id="sidenav-button" class="hamburger" title="Open Menu" aria-label="Open Menu">

接下来,向侧边导航栏关闭链接添加一个 ID:

<a href="#" title="Close Menu" aria-label="Close Menu"></a>
<a href="#" id="sidenav-close" title="Close Menu" aria-label="Close Menu"></a>

以上就是宏观 <body> 自适应堆叠布局的全部内容,此外,我们还将其与网址栏关联了起来。 让我们继续构建吧!

<aside>的布局也很简洁。它有 2 个子级:一个是 <nav>,即滑出的纸张状组件;另一个是关闭 <a> link 元素,用于将网址哈希设置为 #。该链接在纸质滑出式导航栏右侧不可见;这样,用户就可以“点击”视觉组件将其关闭。

将以下 CSS 添加到 css/sidenav.css:

#sidenav-open {
  display: grid;
  grid-template-columns: [nav] 2fr [escape] 1fr;
}

我认为这里的比例和名称非常棒,网格可以大放异彩,让设计师拥有很大的控制权。

接下来,我需要根据条件叠加主要内容,并在文档滚动时保持我的位置。这非常适合 position: sticky 和一些 overscroll-behavior。

为侧边导航栏添加以下样式:

#sidenav-open {
  display: grid;
  grid-template-columns: [nav] 2fr [escape] 1fr;

  @media (max-width: 540px) {
    position: sticky;
    top: 0;
    max-height: 100vh;
    overflow: hidden auto;
    overscroll-behavior: contain;

    visibility: hidden; /* not keyboard accessible when closed */
  }
}

这些样式可确保侧边导航栏的高度与视口高度一致,可垂直滚动,并包含滚动条。非常重要的一点是,它会隐藏元素。默认情况下,当视口为 540px 或更小时,隐藏该侧边栏。除非!

向 #sidenav-open 元素添加 :target 伪选择器:

#sidenav-open {

  @media (max-width: 540px) {

    &:target {
      visibility: visible;
    }
  }
}

当该元素的 ID 与网址栏相同时,请将 visibility 设置为 visible。请在滚动页面后打开侧边菜单,或在侧边导航栏打开时尝试滚动页面。您有何看法?

在 app/sidenav.css 底部添加以下 CSS:

#sidenav-button,
#sidenav-close {
  -webkit-tap-highlight-color: transparent;
  -webkit-touch-callout: none;
  user-select: none;
  touch-action: manipulation;

  @media (min-width: 540px) {
    display: none;
  }
}

这些样式针对的是打开和关闭按钮,指定了它们的点按和触摸样式,并在视口宽度为 540px 或更大时隐藏它们。

为了增添一些趣味,我们来添加 CSS 转换,同时兼顾无障碍功能。 将以下 CSS 添加到 css/sidenav.css:

#sidenav-open {
  --easeOutExpo: cubic-bezier(0.16, 1, 0.3, 1);
  --duration: .6s;

  ...

  @media (max-width: 540px) {
    ...

    transform: translateX(-110vw);
    will-change: transform;
    transition:
      transform var(--duration) var(--easeOutExpo),
      visibility 0s linear var(--duration);

    &:target {
      visibility: visible;
      transform: translateX(0);
      transition: transform var(--duration) var(--easeOutExpo);
    }
  }

  @media (prefers-reduced-motion: reduce) {
    --duration: 1ms;
  }
}
基于 `prefers-reduced-motion` 媒体查询,演示应用了时长和未应用时长的互动。

添加一些 JavaScript

Escape 键应关闭菜单。将以下 JS 添加到 js/index.js:

const sidenav = document.querySelector('#sidenav-open');

sidenav.addEventListener('keyup', e => {
  if (e.code === 'Escape') {
    document.location.hash = '';
  }
});

这会监听侧边栏导航元素上的按键事件。 如果为 Escape,则会将网址哈希设置为空,从而使侧边栏过渡到隐藏状态。

下一个 UX JS 部分是焦点管理。我希望让打开和关闭变得简单,因此我等到侧边导航栏完成某种过渡后,再对照网址哈希进行交叉检查,以确定它是打开还是关闭。然后,我使用 JavaScript 将焦点设置在与他们刚刚按下的按钮互补的按钮上。

将以下 JavaScript 添加到 js/index.js:

const closenav = document.querySelector('#sidenav-close');
const opennav = document.querySelector('#sidenav-button');

sidenav.addEventListener('transitionend', e => {
  if (e.propertyName !== 'transform') {
    return;
  }

  const isOpen = document.location.hash === '#sidenav-open';

  isOpen
    ? closenav.focus()
    : opennav.focus();
});

试试看

  • 如需预览网站,请按查看应用。然后按全屏 全屏。

总结

以上就是我对该组件的需求。您可以随意在此基础上进行构建,使用 JavaScript 状态(而非网址)来驱动它,并根据自己的需求进行定制!总有更多内容需要添加, 或更多用例需要涵盖。

打开 css/brandnav.css,查看我为此组件应用的非布局相关样式。我认为这对我关注的特征集并不重要,而且我希望将样式与布局分开,以鼓励复制和粘贴。您可以在那里学到更多知识!

如何制作滑出式自适应侧边导航栏组件? 您是否曾有过多个,比如两侧各有一个?我很乐意在 YouTube 视频中展示您的解决方案,请务必在 Twitter 上给我发推文或在 YouTube 上评论您的代码,这会对大家有所帮助!