Skip to content

HongxuanG/taro-iconfont-svg

Repository files navigation

taro-iconfont-svg

一款针对 taro3x 的 svg 类型iconfont 组件生成器

灵感来源:taro-iconfont-cli

通过 background:url(data:svg+xml....) 的形式 在小程序上把svg显示出来,目前在公司内部开发中得到实际应用。

image.png

试验田请访问:taro-test-iconfont-svg

支持平台

  • 微信小程序

支持框架

  • React

用法

npm 安装

npm install taro-iconfont-svg -D

也可使用 pnpm 安装

pnpm install taro-iconfont-svg -D

初始化 iconfont.json 文件

执行 npx iconfont-init 初始化配置

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

{
  "symbol_url": "请参考README.md,复制 http://iconfont.cn 官网提供的JS链接",
  "parse_local_svg": false,
  "local_svg_dir": "./src/assert/svg",
  "save_dir": "./src/components/iconfont",
  "default_icon_size": 18,
}

填上阿里矢量图标的svg地址(symbol_url)

symbol_url

请直接复制iconfont官网提供的项目链接。请务必看清是.js后缀而不是.css后缀。如果你现在还没有创建iconfont的仓库,那么可以填入这个链接去测试:http://at.alicdn.com/t/font_1373348_kk9y3jk2omq.js


save_dir

根据iconfont图标生成的组件存放的位置。每次生成组件之前,该文件夹都会被清空。

default_icon_size

我们将为每个生成的图标组件加入默认的字体大小,当然,你也可以通过传入props的方式改变这个size值。

parse_local_svg

是否开启本地svg文件解析

local_svg_dir

本地svg文件存放文件夹的地址

生成自定义组件

执行 npx iconfont-taro 生成自定义组件iconfont

最后在项目中引入新生成的IconFont组件即可

IconFont 组件
参数 类型 说明 默认值
name string 阿里矢量图标Symbol名称,字段唯一表示,必须唯一 -
size number 图标字体大小 -
color string | string[] 图标颜色,如果图标有多个色块,请十六进制颜色字符串组成的数组表示 -
customStyle CSSProperty 自定义行内样式style -
customClassName string 自定义样式class类名 -

About

让Taro也能使用阿里矢量图标库的SVG

Resources

License

Stars

Watchers

Forks

Packages

No packages published