聊聊纯 CSS 图标 - 哈喽比特 - https://www.hellobit.com.cn

285次阅读 | 发布于3年以前

在 [重新构想原子化 CSS] 中，我提到了 UnoCSS[4] 的一个预设，它提供了在纯 CSS 中按需使用任何图标的能力。在这篇文章中，我想和大家分享下它的工作原理。

我的图标探索之旅

如果你对我如何探索图标解决方案的过程感兴趣，下面这个博文列表，是我在图标探索过程中总结和相关实验

2020 年 8 月 - 图标探索之旅[5]
2021 年 9 月 - 图标探索之旅后续[6]
2021 年 10 月 - [重新构想原子化 CSS]
2021 年 11 月 - 聊聊纯 CSS 图标 - 你在这里！

现有方案

有个名为 css.gg[8] 的纯 CSS 图标解决方案，它完全通过伪元素（::before，::after）来构建图标。使用这种方案意味着你需要对 CSS 工作原理有深刻的理解，但同时也很难创造更为复杂的图标（只有3个元素可以使用）。我在寻找 一种更加通用化的解决方案，可以适用于任何图标 而并非在特定集合中进行有限的选择。

我的方案

这个方案来源于社区小伙伴 @husayt[9] 在 unplugin-icons 中提出需求[10] 并由 @userquin[11] 在此 PR 中[12] 提供了初版的实现。这个方案非常简单，用 DataURI[13] 中的图标作为背景图，并生成如下 CSS。

.my-icon {
  background: url(data:...) no-repeat center;
  background-color: transparent;
  background-size: 16px 16px;
  height: 16px;
  width: 16px;
  display: inline-block;
}

有了这种方案，我们就可以使用一个单独的类在 CSS 中内嵌任何图像。

这个想法非常有趣，但是这更其实更像一张图片而非图标。对我而言，一个图标必须是可以根据上下文进行缩放和着色的。

实现

DataURI

再次感谢 Iconify[14]，它将 100 多个图标集与上万个图标统一为一致的 JSON 格式[15]。它允许我们通过简单地提供集合和图标 ID 的方式来获取任意图标集中的 SVG，使用方式如下：

import { iconToSVG, getIconData } from '@iconify/utils'

const svg = iconToSVG(getIconData('mdi', 'alarm'))
// (此处并非真实 API，仅供示意)

当我们得到 SVG 字符串后，可以将其转换为 DataURI：

const dataUri = `data:image/svg+xml;base64,${Buffer.from(svg).toString('base64')}`

说到 DataURI，使用 Base64[16] 几乎一直是我的默认选择 -- 直到我看到 Chris Coyier 所写的你可能不需要使用 Base64 SVG[17] 文章。对于图像等二进制数据必须使用 Base64 进行编码，以便在 CSS 等纯文本文件中使用，而对于 SVG 来说，由于它已经是文本格式，所以使用 Base64 编码实际上会使得文件体积变得变大。

结合 Taylor Hunt 在优化 DataURI 中的 SVG[18] 提到的相关技术，进一步对输出大小进行了改进，以下是我们的最终解决方案。

// https://bl.ocks.org/jennyknuth/222825e315d45a738ed9d6e04c7a88d0
function encodeSvg(svg: string) {
  return svg.replace('<svg', (~svg.indexOf('xmlns') ? '<svg' : '<svg xmlns="http://www.w3.org/2000/svg"'))
    .replace(/"/g, '\'')
    .replace(/%/g, '%25')
    .replace(/#/g, '%23')
    .replace(/{/g, '%7B')
    .replace(/}/g, '%7D')
    .replace(/</g, '%3C')
    .replace(/>/g, '%3E')
}

const dataUri = `data:image/svg+xml;utf8,${encodeSvg(svg)}`

可缩放

使 ”图片“ 更像图标的第一步，我们需要让它可以根据上下文进行缩放。

幸运的是，CSS 为我们提供了原生的缩放支持 —— em 单位。

.my-icon {
  background: url(data:...) no-repeat center;
  background-color: transparent;
  background-size: 100% 100%;
  height: 1em;
  width: 1em;
}

通过改变 height 和 width 为 1em，并设置 background-size 为 100%，我们可以使得图片的比例基于其父级元素的字体大小变化。

可着色

在内联的 SVG 中，我们可以使用 [fill="currentColor"](https://www.w3.org/TR/css-color-3/#currentcolor "fill="currentColor"") 来为 SVG 着色。但是，当我们将其作为背景图时，它就变成了一个图片。SVG 的动态性消失了，currentColor 的效果也随之消失（这和你无法覆盖 PNG 的颜色一样）。

如果你 Google 一下，你会发现大多数人都告诉你告诉你，这个就是个限制没有办法。少部分人会给你提供一个解决方案 -- 在转换为 DataURI 前在 SVG 中设置颜色，这可以解决对于特定图标着色的问题，但是没有从根本上解决上下文着色的问题。

此时，可能会有小伙伴想到使用 CSS filters[19]，就像 Una Kravets 在使用 CSS 给 SVG 背景上色[20] 一文中提到的那样。听起来还不错，也许引入一些运行时的 JavaScript 去计算如何将颜色转化为最终所需的颜色矩阵便可以做到。但这就违背了我们在探索纯 CSS 中图标的目的。

在我快要放弃这个方案时，我无意中发现了 Noah Blon 的在 CSS 背景图片中为 SVGs 上色[21]。文中提到了一个非常绝妙的主意，通过使用 CSS masks[22] 对背景进行蒙版 - 一个从未听说过 CSS 属性。

.my-icon {
  background-color: red;
  mask-image: url(icon.svg);
}

与其想办法给背景图片着色，不如换种思路，把图标作为一个蒙版，来对背景的颜色进行裁剪。这样做，我们还可以使用 currentColor 为其着色！

.my-icon {
  background-color: currentColor;
  mask-image: url(icon.svg);
}

彩色图标

我们把单色的图标做成了可着色的，但又遇到了新的问题。当使用 mask 时，图标的颜色和内容会丢失。例如：

我想，很多时候可能很难通过一种方案来解决所有问题。

但是，其实我们可以使用两种方案！还记得我们最开始提到了将图像作为背景图片的方案吗？这个不正适用于彩色图标 -- 毕竟使用彩色图标时，我们也不需要修改它的颜色。

解决方案其实很简单，我们只需找到一种方法来巧妙地区分单色图标和彩色图标。既然我们可以得到 SVG 的内容，我们便可以使用如下方法：

// 如果 SVG 的图标包含 `currentColor` 的值
// 它大概率是一个单色图标
const mode = svg.includes('currentColor')
  ? 'mask'
  : 'background-img'

const uri = `url("data:image/svg+xml;utf8,${encodeSvg(svg)}")`

// 单色图标
if (mode === 'mask') {
  return {
    'mask': `${uri} no-repeat`,
    'mask-size': '100% 100%',
    'background-color': 'currentColor',
    'height': '1em',
    'width': '1em',
  }
}
// 彩色图标
else {
  return {
    'background': `${uri} no-repeat`,
    'background-size': '100% 100%',
    'background-color': 'transparent',
    'height': '1em',
    'width': '1em',
  }
}

而且最终效果出乎意料的完美！它的效果其实和我们日常接触到的一个工具非常相似 - 系统的原生 Emoji。文本颜色会根据上下文而发生变化，而 Emoji 则保持自己的颜色。

最终效果展示：

如果想要查看或者搜索所有可用的图标，可以参考我的另一个开源项目 Icônes[23]。

使用

如果你想在项目中尝试这个图标解决方案，你可以安装 UnoCSS[24] 和图标预设：

npm i -D unocss @unocss/preset-icons @iconify/json

@iconify/json 包含了所有 Iconify 收录的图标集（120MB 左右）。或者，你也可以按图标集的方式进行安装以节省流量和储存空间，例如，需使用 Material Design 的图标，你可以安装 @iconify-json/mdi，使用 Carbon 的图标，你可以安装 @iconify-json/carbon 等。

接着配置你的 vite.config.js：

import { defineConfig } from 'vite'
import Unocss from 'unocss'
import UnocssIcons from '@unocss/preset-icons'

export default defineConfig({
  plugins: [
    Unocss({
      // 但 `presets` 被指定时，默认的预设将会被禁用，
      // 因此你可以在你原有的 App 上使用纯 CSS 图标而不需要担心 CSS 冲突的问题。
      presets: [
        UnocssIcons({
          // 其他选项
          prefix: 'i-',
          extraProperties: {
            display: 'inline-block'
          }
        }),
        // presetUno() - 取消注释以启用默认的预设
      ],
    }),
  ],
})

这就是今天的全部内容了。希望你能喜欢这个来自 UnoCSS 的图标解决方案，或者能为你提供灵感，用于你自己的项目。

感谢阅读，下次见 :)

参考资料

[1]QC-L: https://github.com/QC-L

[2]English Version: https://antfu.me/posts/icons-in-pure-css

[3]重新构想原子化 CSS: https://antfu.me/posts/reimagine-atomic-css#pure-css-icons

[4]UnoCSS: https://github.com/antfu/unocss

[5]图标探索之旅: https://antfu.me/posts/journey-with-icons

[6]图标探索之旅后续: https://antfu.me/posts/journey-with-icons-continues

[7]重新构想原子化 CSS: https://antfu.me/posts/reimagine-atomic-css-zh

[8]css.gg: https://github.com/astrit/css.gg

[9]@husayt: https://github.com/husayt

[10]需求: https://github.com/antfu/unplugin-icons/issues/88

[11]@userquin: https://github.com/userquin

[12]此 PR 中: https://github.com/antfu/unplugin-icons/pull/90

[13]DataURI: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs

[14]Iconify: https://iconify.design/

[15]一致的 JSON 格式: https://github.com/iconify/collections-json

[16]Base64: https://developer.mozilla.org/en-US/docs/Glossary/Base64

[17]你可能不需要使用 Base64 SVG: https://css-tricks.com/probably-dont-base64-svg/

[18]优化 DataURI 中的 SVG: https://codepen.io/Tigt/post/optimizing-svgs-in-data-uris

[19]CSS filters: https://developer.mozilla.org/en-US/docs/Web/CSS/filter

[20]使用 CSS 给 SVG 背景上色: https://css-tricks.com/solved-with-css-colorizing-svg-backgrounds/

[21]在 CSS 背景图片中为 SVGs 上色: https://codepen.io/noahblon/post/coloring-svgs-in-css-background-images

[22]CSS masks: https://developer.mozilla.org/en-US/docs/Web/CSS/mask

[23]Icônes: https://icones.js.org/

[24]UnoCSS: https://github.com/antfu/unocss