构建主题切换组件

介绍如何构建易于使用的自适应主题切换组件的基本概览。

在本文中,我想分享一下构建深色和浅色主题切换组件的方法。 试用演示版

演示按钮大小,以方便查看

如果你更喜欢视频,可以参阅此博文的 YouTube 版本:

概览

网站可能会提供用于控制配色方案的设置,而不是完全依赖于系统偏好设置。这意味着,用户可以使用除其系统偏好设置之外的模式进行浏览。例如,用户的系统采用浅色主题,但用户希望网站以深色主题显示。

构建此功能时,有几个网页工程方面的考虑事项。例如,浏览器应尽快了解偏好设置,以防止网页颜色闪烁,并且控件需要先与系统同步,然后允许客户端存储的异常。

此图显示了 JavaScript 网页加载和文档互动事件的预览,总体上展示了设置主题的 4 种途径

Markup

应为切换开关使用 <button>,这样您就可以获享浏览器提供的互动事件和功能,例如点击事件和可聚焦性。

按钮

该按钮需要一个用于从 CSS 使用的方法,以及一个用于从 JavaScript 使用的方法。此外,由于按钮内容是图标而非文本,因此请添加 title 属性以提供有关按钮用途的信息。最后,添加一个 [aria-label] 来保存图标按钮的状态,以便屏幕阅读器可以将主题的状态分享给视障人士。

<button 
  class="theme-toggle" 
  id="theme-toggle" 
  title="Toggles light & dark" 
  aria-label="auto"
>
  …
</button>

aria-labelaria-live polite

如需向屏幕阅读器指明应读出对 aria-label 的更改,请向按钮添加 aria-live="polite"

<button 
  class="theme-toggle" 
  id="theme-toggle" 
  title="Toggles light & dark" 
  aria-label="auto" 
  aria-live="polite"
>
  …
</button>

添加此标记会向屏幕阅读器发出信号,以便以礼貌的方式(而不是aria-live="assertive")告知用户发生了哪些变化。对于此按钮,它会根据 aria-label 的状态读出“亮”或“暗”。

可缩放矢量图形 (SVG) 图标

SVG 可用于使用最少的标记创建可伸缩的高品质形状。与按钮互动可以触发矢量的新视觉状态,因此 SVG 非常适合用于图标。

以下 SVG 标记位于 <button> 内:

<svg class="sun-and-moon" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
  …
</svg>

aria-hidden 已添加到 SVG 元素中,因此屏幕阅读器会知道忽略它,因为它已标记为呈现性元素。这非常适合用于视觉装饰,例如按钮内的图标。除了在元素上添加必需的 viewBox 属性之外,还应出于与图片应采用内嵌大小类似的原因添加高度和宽度。

太阳

显示太阳图标,太阳光线已淡出,并且有一个指向中心圆圈的热粉色箭头。

太阳图形由一个圆形和一些线条组成,SVG 非常方便地提供了这些形状。通过将 cxcy 属性设置为 12(即视口大小 [24] 的一半),然后指定半径 (r) 为 6(用于设置大小),将 <circle> 居中显示。

<svg class="sun-and-moon" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
  <circle class="sun" cx="12" cy="12" r="6" mask="url(#moon-mask)" fill="currentColor" />
</svg>

此外,mask 属性指向您接下来要创建的 SVG 元素的 ID,最后使用 currentColor 指定与页面文本颜色匹配的填充颜色。

阳光

显示太阳图标,其中太阳中心已淡出,并有一个指向阳光的热粉色箭头。

接下来,在圆圈正下方的组元素 <g> 组内添加了阳光线条。

<svg class="sun-and-moon" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
  <circle class="sun" cx="12" cy="12" r="6" mask="url(#moon-mask)" fill="currentColor" />
  <g class="sun-beams" stroke="currentColor">
    <line x1="12" y1="1" x2="12" y2="3" />
    <line x1="12" y1="21" x2="12" y2="23" />
    <line x1="4.22" y1="4.22" x2="5.64" y2="5.64" />
    <line x1="18.36" y1="18.36" x2="19.78" y2="19.78" />
    <line x1="1" y1="12" x2="3" y2="12" />
    <line x1="21" y1="12" x2="23" y2="12" />
    <line x1="4.22" y1="19.78" x2="5.64" y2="18.36" />
    <line x1="18.36" y1="5.64" x2="19.78" y2="4.22" />
  </g>
</svg>

这一次,fill 的值不是 currentColor,而是每行的笔触。这些线条和圆圈构成了带有横梁的漂亮太阳。

月亮

为了营造光明(太阳)与黑暗(月亮)之间顺畅过渡的错觉,月亮是使用 SVG 蒙版对太阳图标的增强。

<svg class="sun-and-moon" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
  <circle class="sun" cx="12" cy="12" r="6" mask="url(#moon-mask)" fill="currentColor" />
  <g class="sun-beams" stroke="currentColor">
    …
  </g>
  <mask class="moon" id="moon-mask">
    <rect x="0" y="0" width="100%" height="100%" fill="white" />
    <circle cx="24" cy="10" r="6" fill="black" />
  </mask>
</svg>
一张包含三个垂直图层的图片,用于展示遮盖功能的运作方式。顶部图层是一个带有黑色圆圈的白色方形。中间层是太阳图标。
底部图层标记为结果,它显示了太阳图标,并带有一个刘海屏,其中最上层是黑色圆圈。

采用 SVG 的遮罩功能强大,可以让白色和黑色移除或包含其他图形的某些部分。只需将圆形形状移入和移出蒙版区域,太阳图标就会被带有 SVG 蒙版的月亮 <circle> 形状遮挡。

如果 CSS 无法加载,会出现什么情况?

一个带有太阳图标的普通浏览器按钮的屏幕截图。

最好像未加载 CSS 一样测试 SVG,以确保结果不会超大或导致布局问题。SVG 上的内嵌 height 和 width 属性以及 currentColor 的使用为浏览器提供了最少的样式规则,以便在 CSS 无法加载时使用。这就形成了可抵御网络扰动的良好防御方式。

布局

主题切换器组件占用的空间很小,因此您无需使用网格或 Flexbox 来进行布局。而是使用 SVG 定位和 CSS 转换。

样式

.theme-toggle 种样式

<button> 元素是图标形状和样式的容器。此父级上下文将包含自适应颜色和尺寸传递给 SVG。

第一项任务是将按钮设为圆形,并移除默认按钮样式:

.theme-toggle {
  --size: 2rem;
  
  background: none;
  border: none;
  padding: 0;

  inline-size: var(--size);
  block-size: var(--size);
  aspect-ratio: 1;
  border-radius: 50%;
}

接下来,添加一些互动样式。为鼠标用户添加了光标样式。添加了 touch-action: manipulation,以实现快速响应的触控体验。移除 iOS 应用于按钮的半透明突出显示效果。最后,为聚焦状态轮廓留出与元素边缘之间的一些空间:

.theme-toggle {
  --size: 2rem;

  background: none;
  border: none;
  padding: 0;

  inline-size: var(--size);
  block-size: var(--size);
  aspect-ratio: 1;
  border-radius: 50%;

  cursor: pointer;
  touch-action: manipulation;
  -webkit-tap-highlight-color: transparent;
  outline-offset: 5px;
}

按钮内的 SVG 也需要一些样式。SVG 应符合按钮的尺寸,并且为了实现柔和的视觉效果,请将线条末端设为圆角:

.theme-toggle {
  --size: 2rem;

  background: none;
  border: none;
  padding: 0;

  inline-size: var(--size);
  block-size: var(--size);
  aspect-ratio: 1;
  border-radius: 50%;

  cursor: pointer;
  touch-action: manipulation;
  -webkit-tap-highlight-color: transparent;
  outline-offset: 5px;

  & > svg {
    inline-size: 100%;
    block-size: 100%;
    stroke-linecap: round;
  }
}

使用 hover 媒体查询进行自适应调整

图标按钮大小为 2rem,略小,对于鼠标用户来说没问题,但对于手指等粗糙指针来说,可能很难操作。使用悬停媒体查询指定增大尺寸,使按钮符合许多触摸大小准则

.theme-toggle {
  --size: 2rem;
  
  
  @media (hover: none) {
    --size: 48px;
  }
}

太阳和月亮 SVG 样式

按钮包含主题切换器组件的互动方面,而内部的 SVG 将包含视觉和动画方面。这时,图标可以变得美观而生动

浅色主题

ALT_TEXT_HERE

如需从 SVG 形状的中心缩放和旋转动画,请设置其 transform-origin: center center。此处的形状使用了按钮提供的自适应颜色。月亮和太阳使用提供的按钮 var(--icon-fill)var(--icon-fill-hover) 进行填充,而阳光则使用这些变量进行描边。

.sun-and-moon {
  & > :is(.moon, .sun, .sun-beams) {
    transform-origin: center center;
  }

  & > :is(.moon, .sun) {
    fill: var(--icon-fill);

    @nest .theme-toggle:is(:hover, :focus-visible) > & {
      fill: var(--icon-fill-hover);
    }
  }

  & > .sun-beams {
    stroke: var(--icon-fill);
    stroke-width: 2px;

    @nest .theme-toggle:is(:hover, :focus-visible) & {
      stroke: var(--icon-fill-hover);
    }
  }
}

深色主题

ALT_TEXT_HERE

月球样式需要移除阳光,放大太阳圆圈并移动圆形蒙版。

.sun-and-moon {
  @nest [data-theme="dark"] & {
    & > .sun {
      transform: scale(1.75);
    }

    & > .sun-beams {
      opacity: 0;
    }

    & > .moon > circle {
      transform: translateX(-7px);

      @supports (cx: 1px) {
        transform: translateX(0);
        cx: 17px;
      }
    }
  }
}

请注意,深色主题没有颜色变化或过渡。父级按钮组件拥有颜色,这些颜色已在深色和浅色背景中进行自适应。转换信息应位于用户的动作偏好媒体查询之后。

动画

此时,按钮应处于可正常使用且具有状态的状态,但没有转场效果。以下部分将介绍如何定义转换方式转换内容

共享媒体查询和导入缓动

为了轻松在用户的操作系统动作偏好设置后面放置过渡和动画效果,PostCSS 插件自定义媒体支持使用媒体查询变量的 CSS 规范草案语法:

@custom-media --motionOK (prefers-reduced-motion: no-preference);

/* usage example */
@media (--motionOK) {
  .sun {
    transition: transform .5s var(--ease-elastic-3);
  }
}

如需使用独特且易用的 CSS 缓动效果,请导入 Open Props缓动效果部分:

@import "https://unpkg.com/open-props/easings.min.css";

/* usage example */
.sun {
  transition: transform .5s var(--ease-elastic-3);
}

太阳

太阳的转换效果会比月亮更活泼,我们可以通过弹跳缓动来实现此效果。阳光在旋转时应略微弹跳,太阳中心在缩放时也应略微弹跳。

默认(浅色主题)样式用于定义转换,深色主题样式用于定义向浅色主题的转换的自定义设置:

​​.sun-and-moon {
  @media (--motionOK) {
    & > .sun {
      transition: transform .5s var(--ease-elastic-3);
    }

    & > .sun-beams {
      transition: 
        transform .5s var(--ease-elastic-4),
        opacity .5s var(--ease-3)
      ;
    }

    @nest [data-theme="dark"] & {
      & > .sun {
        transform: scale(1.75);
        transition-timing-function: var(--ease-3);
        transition-duration: .25s;
      }

      & > .sun-beams {
        transform: rotateZ(-25deg);
        transition-duration: .15s;
      }
    }
  }
}

在 Chrome 开发者工具的 Animation 面板中,您可以找到动画过渡的时间轴。您可以检查整个动画的时长、各个元素以及加/减速时间。

从浅到深的过渡
从深到浅的过渡

月亮

月亮亮度和深色位置已设置完毕,请在 --motionOK 媒体查询中添加转换样式,以便在遵循用户的动作偏好设置的同时使其生动起来。

延迟时间和时长对于确保此次过渡的顺利进行至关重要。例如,如果太阳过早被遮挡,过渡效果就不会给人精心设计或轻松愉快的感觉,而是混乱无序。

​​.sun-and-moon {
  @media (--motionOK) {
    & .moon > circle {
      transform: translateX(-7px);
      transition: transform .25s var(--ease-out-5);

      @supports (cx: 1px) {
        transform: translateX(0);
        cx: 17px;
        transition: cx .25s var(--ease-out-5);
      }
    }

    @nest [data-theme="dark"] & {
      & > .moon > circle {
        transition-delay: .25s;
        transition-duration: .5s;
      }
    }
  }
}
浅色到深色过渡
深色到浅色过渡

首选减少动画效果

在大多数 GUI 挑战中,我会尽量保留一些动画(例如不透明度交叉淡出),以便那些更喜欢减少动作的用户使用。不过,使用即时状态更改后,此组件看起来更好了。

JavaScript

此组件中的 JavaScript 有很多工作要做,从管理屏幕阅读器的 ARIA 信息到从本地存储空间获取和设置值。

网页加载体验

加载网页时不能闪烁颜色。如果采用深色配色方案的用户表示他们更喜欢此组件的浅色,然后重新加载页面,则页面最初会是深色,然后闪烁为浅色。为防止出现这种情况,需要运行少量阻塞 JavaScript,目标是尽早设置 HTML 属性 data-theme

<script src="./theme-toggle.js"></script>

为此,系统会先在文档 <head> 中加载纯 <script> 标记,然后再加载任何 CSS 或 <body> 标记。当浏览器遇到这样一个未标记的脚本时,它会运行代码并在 HTML 的其余部分之前执行该代码。谨慎使用此阻塞时刻,可以在主 CSS 绘制页面之前设置 HTML 属性,从而防止闪烁或颜色变化。

JavaScript 会先在本地存储空间中查找用户的偏好设置,如果在存储空间中找不到任何内容,则会回退以检查系统偏好设置:

const storageKey = 'theme-preference'

const getColorPreference = () => {
  if (localStorage.getItem(storageKey))
    return localStorage.getItem(storageKey)
  else
    return window.matchMedia('(prefers-color-scheme: dark)').matches
      ? 'dark'
      : 'light'
}

接下来,系统会解析用于在本地存储空间中设置用户偏好的函数:

const setPreference = () => {
  localStorage.setItem(storageKey, theme.value)
  reflectPreference()
}

后跟一个函数,用于修改具有偏好设置的文档。

const reflectPreference = () => {
  document.firstElementChild
    .setAttribute('data-theme', theme.value)

  document
    .querySelector('#theme-toggle')
    ?.setAttribute('aria-label', theme.value)
}

此时需要注意的重要事项是 HTML 文档解析状态。由于 <head> 标记尚未完全解析,因此浏览器尚不了解“#theme-toggle”按钮。不过,该浏览器确实有一个 document.firstElementChild(也称为 <html> 标记)。该函数会尝试设置这两者以保持它们同步,但在首次运行时,将只能设置 HTML 标记。querySelector 最初不会找到任何内容,并且可选链接运算符可确保在未找到它且尝试调用 setAttribute 函数时不会出现语法错误。

接下来,系统会立即调用函数 reflectPreference(),以便为 HTML 文档设置 data-theme 属性:

reflectPreference()

该按钮仍需要该属性,因此请等待网页加载事件,然后才能安全地查询、添加监听器并设置以下属性:

window.onload = () => {
  // set on load so screen readers can get the latest value on the button
  reflectPreference()

  // now this script can find and listen for clicks on the control
  document
    .querySelector('#theme-toggle')
    .addEventListener('click', onClick)
}

切换体验

点击该按钮时,需要在 JavaScript 内存和文档中交换主题。您需要检查当前主题值并确定其新状态。设置新状态后,保存并更新文档:

const onClick = () => {
  theme.value = theme.value === 'light'
    ? 'dark'
    : 'light'

  setPreference()
}

与系统同步

此主题切换的独特之处在于,它会随着系统偏好设置的更改而同步。如果用户在页面和此组件可见时更改其系统偏好设置,主题开关将更改以匹配新的用户偏好设置,就好像用户在进行系统切换的同时与主题开关进行了互动。

您可以使用 JavaScript 和监听媒体查询更改的 matchMedia 事件来实现此目的:

window
  .matchMedia('(prefers-color-scheme: dark)')
  .addEventListener('change', ({matches:isDark}) => {
    theme.value = isDark ? 'dark' : 'light'
    setPreference()
  })
更改 MacOS 系统偏好设置会更改主题开关状态

总结

现在您已经知道我是如何解决的,您会怎么做? 🙂

让我们多元化我们的方法,了解在 Web 上构建的所有方式。 制作一个演示版,在推特上向我发送链接,我会将其添加到下方的社区混剪部分!

社区混剪作品