发布·  

Nuxt Icon v1 发布

探索 Nuxt Icon v1 - 一款适用于您的 Nuxt 项目的现代化、多功能、可定制的图标解决方案。
Anthony Fu

Anthony Fu

@antfu

图标是现代网页界面的重要组成部分。它们简化了导航,明确了功能,并增强了视觉吸引力。然而,高效地实现图标面临着可伸缩性、动态加载和服务器端渲染 (SSR) 兼容性等挑战。

为了应对这些挑战,我们开发了 Nuxt Icon v1——一款专为 Nuxt 项目量身定制的多功能现代化解决方案。通过借鉴成熟的图标渲染技术并引入新颖的方法,Nuxt Icon 在性能、可用性和灵活性之间架起了桥梁。

在这篇文章中,我们将探讨图标渲染的挑战、图标解决方案的演变,以及 Nuxt Icon 如何结合这些方法的最佳方面,为开发者提供无缝体验。


为什么图标具有挑战性?

乍一看,图标似乎很简单——它们本质上只是微小的图像元素,用于增强用户界面,提供视觉提示并提高可用性。

然而,从工程角度来看,它们带来了几个挑战。理想的图标应该具备以下特点:

  • 可着色:适应主题和配色方案。
  • 可伸缩:在各种尺寸和分辨率下都能清晰渲染。
  • 可管理:图标集可能包含数百或数千个图标。
  • 高效打包:最小化网络请求。
  • 优化加载:影响应用程序性能和用户体验。
  • 动态:支持用户生成或运行时定义的图标的动态加载。

满足所有这些需求需要一个精心设计的解决方案,以平衡各种权衡。让我们探讨图标解决方案的演变以及它们如何应对这些挑战。


图标解决方案之旅

多年来,开发者们尝试了各种技术来高效地渲染图标。让我们探索这些解决方案的演变以及它们所面临的挑战。

1. <img> 标签:早期

最直接的解决方案:使用 <img> 标签。这是早期网页的首选方法。

您将托管您的图像资产,并使用 <img> 标签链接到该图像,并指定其宽度和高度。它简单,不需要设置或运行时依赖,并且在浏览器中原生工作。

然而,也存在缺点。图像可能会像素化,缺乏颜色控制,并且无法很好地缩放。每个图标都是一个单独的图像文件,导致许多网络请求,这可能会很慢,尤其是在 HTTP 1.1 时代。在图像下载之前,您可能会看到隐形图标的闪烁,这可能会损害用户体验。最后,编写起来相当冗长,因为您需要指定图像的完整路径并管理相对路径。这解释了为什么这种方法在现代网站上很少使用。


2. 网页字体:图标字体

作为图标演进的下一步,网页字体成为一种流行的解决方案。字体本质上是矢量化和可着色的,使其成为图标的天然选择。

图标集提供商通常将其图标编译成一个特殊的字体文件,为每个图标分配一个唯一的 Unicode 字符。同时附带一个 CSS 文件,将这些 Unicode 值映射到特定的图标类。

这种方法的优点显而易见:易于使用、可着色、可缩放,并且只需一次请求即可加载所有图标。

然而,也有一些缺点。预先加载大型字体文件可能会很慢,并且定制图标集具有挑战性。此外,在字体加载之前,您可能会遇到隐形图标的闪烁,因为没有可用的回退字体。


3. 内联 SVG:基于组件的图标

随着现代前端框架的出现,重用 HTML 元素变得显著容易。这导致了直接将 SVG 标签内联为组件的想法。

为了支持这种方法,许多图标集提供了针对每个框架量身定制的包装包。例如,MDI 图标使用共享组件并通过 props 传递图标数据,而 Tabler 图标为每个图标提供专用组件。

由于这些是 SVG,它们本质上是可着色、可伸缩的,并保留了 SVG 的所有特性。通常,图标会被打包到应用程序中,消除了额外的网络请求,并确保它们是 SSR 友好的,并在首次渲染时可见。

然而,这种方法也有其缺点。它会生成大量的 SVG DOM 元素,当使用许多图标时可能会影响性能。它还会增加捆绑包大小,并且需要针对每个图标集和框架组合进行特定的集成支持,从而导致一定程度的供应商锁定。这使得切换到不同的图标集或框架变得具有挑战性。

尽管存在这些权衡,但这种方法在今天被广泛采用,因为对于大多数项目来说,切换图标集或框架并不是一个频繁的需求。


4. Iconify Runtime:动态 API 访问

Iconify通过聚合超过 100 多个集合中的 200,000 多个图标,彻底改变了图标的使用方式。其运行时解决方案通过 API 动态获取图标,从而无需预打包即可动态访问任何图标。

这非常适合渲染来自用户提供的内容或您在构建时不知道的其他动态内容中的图标。而且设置起来非常容易,因为您甚至可以将其用作 CDN,而无需任何构建工具。

虽然这种方法提供了极大的灵活性,但它确实带来了一些权衡。它引入了运行时依赖,这意味着图标只有在 JavaScript 加载并获取图标数据后才会渲染。这种方法还对服务器端渲染 (SSR) 和缓存层(例如渐进式 Web 应用程序 (PWA) 中使用的缓存层)提出了挑战。


5. 按需组件图标

借助 Iconify 的统一接口和 Vite 的按需方法,我们开发了unplugin-icons。此工具允许您按需导入任何图标作为组件。

作为unplugin,它支持所有流行的构建工具,包括 Vite、webpack 和 rspack。我们为 Vue、React、Svelte 和 Solid 等流行框架提供编译器。借助 Iconify,您可以在任何框架中使用任何图标,最大程度地减少供应商锁定。

虽然此技术与以前的组件图标解决方案具有相同的优缺点,但与构建工具的集成使我们能够提供完整的 Iconify 集合,同时只打包您实际使用的图标。然而,DOM 元素管理等运行时问题仍然存在。


6. 纯 CSS 图标

作为开发UnoCSS的副产品,我们发现了将图标完全嵌入 CSS 的潜力,从而产生了创新的解决方案纯 CSS 图标.

这种方法涉及将 SVG 图标内联为数据 URL,并提供一个单独的类来显示图标。经过一些调整,这些图标变得可着色、可缩放,甚至能够显示 SVG 动画。

浏览器可以缓存 CSS 规则,并且每个图标只需 一个 DOM 元素 即可渲染。这种方法在一个 CSS 文件中打包图标,无需额外请求。由于它是纯 CSS,图标与您的 UI 其余部分一起显示,不需要运行时,并且与 SSR 自然协同工作——您的服务器不需要在服务器端进行任何额外工作。

唯一的缺点是 SVG 内部元素的完全定制能力不足,并且需要在构建时打包图标,这不具备动态性。


集成到 Nuxt 中的挑战

虽然我会说纯 CSS 图标等等按需组件图标对于大多数静态用法来说已经足够了,但 Nuxt 作为功能齐全的框架,在高效集成图标方面有更多的要求

  • SSR/CSR:Nuxt 既支持服务器端渲染 (SSR) 模式,也支持客户端渲染 (CSR) 模式。我们非常关心最终用户体验,我们希望确保图标能够即时渲染而不会闪烁。
  • 动态图标:在类似Nuxt Content的集成中,内容可以在运行时或从外部源提供,这些我们在构建时是不知道的。我们希望确保我们能够很好地与这些情况集成。
  • 性能:我们希望确保图标高效打包,并优化图标加载以实现最佳性能。
  • 自定义图标:虽然 Iconify 提供了广泛的图标可供选择,但我们也意识到项目拥有自己的图标集或使用 Iconify 中没有的付费图标是很常见的。支持自定义图标对我们的用户至关重要。

考虑到这些要求,让我们重新审视我们之前讨论的解决方案,看看它们如何叠加。

对于动态图标,Iconify Runtime 脱颖而出,成为一个可行的选择。它允许动态获取图标,使其适用于在构建时不知道的内容。然而,它也有其缺点。对运行时依赖的依赖意味着它不能与 SSR 无缝集成,并且不支持自定义图标,因为请求被定向到 Iconify 的服务器,这些服务器无法访问我们的本地图标设置。

相反,纯 CSS 图标提供了出色的性能和 SSR 兼容性。它们确保图标即时渲染而不会闪烁,并且高效打包。然而,它们在动态图标方面表现不足,因为它们需要在构建时打包,并且缺乏适应运行时内容更改的灵活性。

平衡这些权衡确实具有挑战性。那么,为什么不利用这两种方法的优势呢?通过理解这些权衡,我们可以更好地欣赏 Nuxt Icon v1 提供的平衡解决方案。


介绍 Nuxt Icon v1:两全其美的平衡

凭借 Nuxt 模块系统的灵活性,Nuxt Icon 结合了两种方法的优点:CSS 图标的即时渲染和 Iconify 图标的动态获取。这种双重方法提供了一种多功能、现代化且可定制的图标解决方案,可无缝适应您项目的需求。

双重渲染模式

为了解决渲染方法中的权衡,Nuxt Icon 引入了一个多功能的 <Icon> 组件,它支持 CSS 和 SVG 模式,这两种模式都对 SSR 友好。根据您的定制需求,您可以为每个图标在这两种模式之间切换。

在 CSS 模式下,图标在 SSR 期间包含在 CSS 中,确保它们即时渲染而无需任何运行时成本。在 SVG 模式下,图标在 SSR 期间以内联 HTML 的形式存在,提供相同的即时渲染优势。这两种方法都确保图标在初始屏幕上立即显示,提供无缝的用户体验。


图标包

动态图标带来了独特的挑战,尤其是在高效加载它们方面。为了解决这个问题,我们利用了 Iconify 的 API,它允许我们通过网络请求按需提供任何图标。然而,仅依靠此 API 可能会引入延迟,特别是如果服务器在地理上与您的用户距离较远。

为了缓解这个问题,我们引入了图标包的概念。我们可以将常用图标直接打包到 客户端包 中。这确保了这些图标可以即时渲染,而无需额外的网络请求。然而,打包所有可能的图标并不可行,因为可能会增加包大小。

鉴于 Nuxt 是一个全栈框架,我们可以通过引入 服务器包 来取得平衡。在服务器端,包大小问题较小,允许我们包含更广泛的图标集。在 SSR 期间,这些图标可以快速获取并根据需要发送到客户端。这种设置确保了常用图标的高性能,同时仍提供了从 Iconify 提供任何图标作为回退的灵活性。

通过将客户端打包用于静态图标和服务器端打包用于动态图标相结合,我们实现了性能和灵活性之间的最佳平衡。


数据流

这是说明 Nuxt Icon 如何请求图标数据的数据流图

  1. 您使用 <Icon> 组件并提供图标 名称
  2. Nuxt Icon 将首先检查图标是否在 客户端包 或 SSR 有效负载(在 SSR 期间已知的图标将出现在有效负载中)中可用。如果是,图标将立即渲染。
  3. 如果图标在客户端不可用,Nuxt Icon 将从您的 Nuxt 应用程序附带的服务器 API 获取图标数据。在服务器端点内部,它将从 服务器包 中查询以查看图标是否可用。
  4. 在此期间,涉及多个缓存系统。服务器端点缓存、HTTP 缓存和客户端缓存,以确保图标高效快速地获取。由于图标数据不经常更改,我们使用硬缓存策略以确保最佳性能。
  5. 当图标在客户端和服务器端都未知(动态图标)时,服务器端点将回退到 Iconify API 来获取图标数据。由于服务器端点是缓存的,Iconify API 对于每个唯一的图标只会调用一次,无论有多少客户端请求它,以节省双方的资源。

这种分层方法确保了高效的图标交付,平衡了速度和灵活性,同时尽可能动态。并平衡了每个解决方案之间的权衡。


立即试用 Nuxt Icon

Nuxt Icon v1 代表了图标渲染领域多年创新的结晶。无论您是构建动态应用程序、静态网站还是介于两者之间的任何东西,Nuxt Icon 都能适应您的需求。

通过运行以下命令,您可以轻松将 Nuxt Icon 添加到您的项目中

npx nuxi module add icon

然后,在您的 Vue 组件中导入 <Icon> 组件,并按照Iconify 的约定:

<template>
  <Icon name="i-lucide-activity" />
</template>

提供图标 名称文档探索更多,试验其功能,并告诉我们您的想法。我们很高兴看到 Nuxt Icon 如何改变您的项目!

祝您 Nuxting 愉快 ✨