如何优雅地在微信小程序使用 SVG 字体图标

发表于 2年以前  | 总阅读数:458 次

本文思路来自实际项目的重构总结,欢迎纠正和交流。如果对你有帮助,还请点赞收藏支持一下啦。

最近在重构一个项目,主要是做 H5 端和小程序端,这次打算开始多做总结啦,之前已经总结一篇[《如何优雅的管理 HTTP 请求和响应拦截器?》] 。

如果大家还有其他方案,欢迎一起探讨哈~ 喜欢本文的朋友给个赞鼓励一下哈~

一、需求思考和方案设计

本文介绍的项目是使用 Taro框架进行多端开发,目前主要适配 H5 端和微信小程序端。项目使用的字体图标库内部维护,目前托管在 iconfont 上。

1. 问题分析

最近在重构的项目比较古老(其实也就去年的),项目中使用到的图标早已更新 N 个迭代了,已经由「单色图标」更新到「多色图标」 很明显好看多了。

这里先按照 iconfont 的规则看看单色图标和多色图标使用上的区别:

单色图标的使用

单色图标使用起来比较简单(以 font-class 引用为例),只需要 2 个步骤:

  • 第一步:拷贝项目下面生成的fontclass代码:
//at.alicdn.com/t/font_8d5l8fzk5b87iudi.css
  • 第二步:挑选相应图标并获取类名,应用于页面:
<i class="iconfont icon-xxx"></i>

多色图标的使用

多色图标使用起来也很简单(以 symbol 引用为例),只需要 3 个步骤:

  • 第一步:拷贝项目下面生成的symbol代码:
//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js
  • 第二步:加入通用css代码(引入一次就行):
<style type="text/css">
    .icon {
       width: 1em; height: 1em;
       vertical-align: -0.15em;
       fill: currentColor;
       overflow: hidden;
    }
</style>
  • 第三步:挑选相应图标并获取类名,应用于页面:
<svg class="icon" aria-hidden="true">
    <use xlink:href="#icon-xxx"></use>
</svg>

这两种图标在使用上都非常方便,那大家是不是会好奇,我们写本文的目的?

原因是,「微信小程序上不支持 SVG 字体图标! 而多色图标,是需要借助 SVG 标签来实现。」

于是我在小程序文档找了好久,也只看到了 <Image> 组件能够使用 SVG,介绍如下:

image图片。支持 JPG、PNG、SVG、WEBP、GIF 等格式,2.3.0 起支持云文件ID。

其属性 src 的值为图片资源地址,这就意味着,不能使用 SVG 字体图标了。因此我们需要想想变通的办法。

(这里不讨论将 iconfont 上图标下载为图片来引用的情况)

2. 方案设计

既然我们了解了单色图标和多色图标的使用方式:

  • 单色图标:任意标签(如 div 标签) + 对应字体图标 class 名称
  • 多色图标:使用 svg 标签 + use 标签设置 xlink:href 属性

首先马上想到的是,能不能集合两者使用方式,实现任意标签通过 class 名称来使用多色图标?

答案是可以的,只需要对图标文件进行格式转换,即 「将多色字体图标转换为能通过class名称来引用的字体图标文件」

那接下来只要看看如何实现格式转换即可。

二、重构后的效果

这边我以其中一个页面进行重构,最后将单色图标全都换成新的多色 SVG 字体图标,效果如下:

三、方案一:手动转换图标文件

目前我尝试了两套方案,并且都顺利实现效果,这边先分享一下这两种方案,然后再补充说明我选择哪个方案和原因:

该方案实现的是手动将字体图标库文件转换成能通过 class 名称来引用的图标库。使用到的工具有:

  1. icomoon:https://icomoon.io/ 用来打包图标。
  2. transfonter:https://transfonter.org/ 用来生成 base64 格式的图标。

接下来开始试试:

步骤一:通过 iconfont 下载需要的 SVG 格式的图标

这边多下载了几个,都是 svg 格式的文件,如下图:

步骤二:打包字体图标

这一步是将零散个多个 SVG 多色图标打包成一个字体图标文件,这一步需要使用 https://icomoon.io/:

步骤三:字体图标进行 Base64 编码

接下来就需要将打好的字体图标进行 base64 压缩,这边使用https://transfonter.org/来操作。

第一步选择前面打好的包里面的 .ttf 文件:

设置参数,并导出文件:

步骤四:合并字体图标

经过前面几个步骤,我们现在已经有 2 个包:

  • 第一个包:icomoon 生成的包

  • 第二个包:transfonter 生成的包

接下来我们开始将两个包合并:将第一个包 style.css 文件除 @font-face 的内容复制到第二个包 stylesheet.css 文件后面。

这样就获得一份新的字体图标文件,其实也可以拷贝到一份新的 css 文件中。

使用字体图标

我们将前面修改后的文件改名为 icon.scss 并引入到项目:

// app.scss

@import "./style/icon.scss";

代码中使用图标:

<View className="icon-exe-knowledge-ppt">
  <View className='path1'></View>
  <View className='path2'></View>
  <View className='path3'></View>
  <View className='path4'></View>
  <View className='path5'></View>
  <View className='path6'></View>
</View>

最后效果如下:

踩坑记录

在使用方案一的时候,踩了好几个坑,这边挑两个来说:

  • 使用时,需要手动添加几个 <View classname="path*"></View> 元素

刚开始使用,图标一直没有出来,后面观察字体图标,它是在容器元素下很多个 path1path2 等元素的伪类中去渲染图标内容:

所以使用时需要手动添加一下。

  • 默认图标会是一个大的块级元素,导致图标显示有问题

这是因为手动加的 class 为 path*View 标签本身是块级元素,所以这里只要简单加个 display: flex 即可。

并且其字体大小,也是可以使用 font-size 来设置:

display: flex;
font-size: 100px;

抽取组件

考虑到复用性,我将这些抽成一个 exe-svg-icon 组件:

import Taro from '@tarojs/taro';
import { View, Text } from '@tarojs/components';
import classNames from 'classnames';

function EXESvgIcon(params) {
  const { icon = 'exe-none' } = params;
  const containerStyle = {
    display: 'inline-block'
  }
  return (
    <View className={classNames('svg', icon)} style={containerStyle}>
      <View className='path1' style={containerStyle}></View>
      <View className='path2' style={containerStyle}></View>
      <View className='path3' style={containerStyle}></View>
      {/* 一般图标 3 层,这边多预留几层,防止不够用 */}
      <View className='path4' style={containerStyle}></View>
      <View className='path5' style={containerStyle}></View>
      <View className='path6' style={containerStyle}></View>
      <View className='path7' style={containerStyle}></View>
      <View className='path8' style={containerStyle}></View>
      <View className='path9' style={containerStyle}></View>
    </View>
  )
}
export default EXESvgIcon;

到这边,方案一实现完成。

四、方案二:借助第三方库实现

由于第一个方案使用起来比较繁琐,于是我又再研究其他简单点的方案。

直到我看到 taro-iconfont-cli 这个库。

在Taro框架中使用iconfont图标,不依赖字体,支持多色彩。

目前支持平台包括:

  • 微信小程序
  • 支付宝小程序
  • 百度小程序
  • 头条小程序
  • QQ小程序
  • H5

有以下特性:

  • 一键生成标准组件,多端支持
  • 使用方便,import即可
  • 支持多色彩
  • 支持自定义颜色
  • 支持 ES6 和 TypeScript 两种模式

按照文档描述,只需要 3 个步骤,那么试试看:

步骤一:安装 taro-iconfont-cli

# Yarn
yarn add taro-iconfont-cli --dev

# Npm
npm install taro-iconfont-cli --save-dev

需要注意的是,如果使用的是 Taro 2.x,请安装 taro-iconfont-cli@2.1.0,并阅读旧版的README.md。

步骤二:生成配置文件

通过命令生成 iconfont.json 配置文件:

npx iconfont-init

# 可传入配置输出路径
# npx iconfont-init --output iconfont.json

此时项目根目录会生成一个iconfont.json的文件,内容如下:

{
  "symbol_url": "请参考README.md,复制 http://iconfont.cn 官网提供的JS链接",
  "save_dir": "./src/components/iconfont",
  "use_typescript": false,
  "platforms": "*",
  "use_rpx": true,
  "trim_icon_prefix": "icon",
  "default_icon_size": 18,
  "design_width": 750
}

symbol_url 值需要在 iconfont 中复制

步骤三:生成 Taro 标准组件

通过命令,生成 Taro 标准组件:

npx iconfont-taro

# 可传入配置文件路径
# npx iconfont-taro --config iconfont.json

通过控制台,我们可以看到 taro-iconfont-cli 为每个图标单独生成一个 Taro 组件:

使用字体图标

按照文档使用方法,使用的时候,只需要引入 IconFont 组件,通过 name 名称来选择对应图标即可:

// 省略其他代码

import IconFont from '@components/Iconfont/index';

<IconFont name="exe-knowledge-ppt"></IconFont>

按照文档提示,还有更多使用方法:

// 原色彩
<IconFont name="alipay" />

// 单色:红色
<IconFont name="alipay" color="red" />

// 多色:红色+橘色
<IconFont name="alipay" color={['red', 'orange']} size={300} />

// 不同格式的颜色写法
<IconFont name="alipay" color={['#333', 'rgb(50, 124, 39)']} />

// 与文字对齐
<View style={{ display: 'flex', alignItems: 'center' }}>
  <Text>Hello</text>
  <IconFont name="alipay" />
</View>

踩坑记录

1 . 字体大小设置问题

由于通过这种方式导出的图标,是个单独组件,使用时如果需要设置图标大小,需要通过设置其 widthheight属性进行设置。

通过 font-size属性无法设置字体图标的大小。

五、方案对比和选择

这次只尝试了这两种方案,都能顺利完成需求。如果大家有其他方案,欢迎一起评论区讨论~

接下来「以生成下面相同 20 个多色图标为标准,分析这两种方案:」

先看看对比结果:

手动转换图标文件 借助 taro-iconfont-cli 库实现
生成难易程度 复杂 简单
使用难易程度 简单 简单
资源占用程度 27kb 420kb(项目未打包前)

分析每个项目:

1. 对比生成难易程度

  • 「手动转换图标文件」需要每次将图标单独下载,再进行打包,当图标数量较多,其工作量就较大。
  • 「taro-iconfont-cli」只需设置字体图标库地址,自动下载并生成组件,较为方便。

2. 对比使用难易程度

两者使用起来都比较简单:

  • 「手动转换图标文件」为元素添加 class 名称即可。
  • 「taro-iconfont-cli」为元素添加 name 属性。

3. 对比资源占用情况

资源占用差异就很大了,分析下原因:

  • 「手动转换图标文件」是将图标重新打包,最后生成的都是 base64 编码的内容,相对较小。
  • 「taro-iconfont-cli」是为每个图标生成一个组件,单独一个文件,还有附加各个平台的文件,因此较大。

4. 选择方案

考虑到目前项目所使用的字体图标比较少(20 个以内),后续开发人员上手难度问题,我最终使用「taro-iconfont-cli」这套方案。虽然这个方案生成的组件资源占用会稍大,但是目前使用图标较少,并且可以通过打包工具、CDN 等常用优化方式进行优化。

六、本文总结

本文通过一次简单的项目重构,总结项目中小程序使用 SVG 多色图标的方案,目的是为了实现在小程序中能够正常使用 SVG 多色图标,并且也为内容越来越多独立站点的项目积累经验,毕竟各个项目具有相关性。

最后,「taro-iconfont-cli」方案目前已经在内部 npm 仓库维护,采用版本控制,方便不同项目使用时减少冲突。

当然,本文是基于我的经验总结,欢迎大家有更好的方案,一起讨论学习~~

参考文章

  • 微信小程序中使用svg字体图标教程 ——图解三步,很清晰 (https://blog.csdn.net/Originally_M/article/details/106473475)
  • Taro-Iconfont (https://gitee.com/mirrors/Taro-Iconfont)

本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/_Zfp5ypSDQf7azCAJLzaGQ

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237271次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8108次阅读
 目录