Gathering detailed insights and metrics for react-native-iconfont-cli
Gathering detailed insights and metrics for react-native-iconfont-cli
Installations
npm install react-native-iconfont-cliDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
14.16.1
NPM Version
6.14.12
Releases
21
Languages
3
TypeScript
JavaScript
Shell
TypeScript (62.55%)
JavaScript (35.55%)
Shell (1.9%)
Developer
iconfont-cli
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
470 Stars
123 Commits
64 Forks
6 Watchers
8 Branches
5 Contributors
Updated on Jul 12, 2025
Maintainers
1
Package Meta Information
Latest Version
2.2.4
Package Id
react-native-iconfont-cli@2.2.4
Unpacked Size
32.62 kB
Size
9.85 kB
File Count
35
NPM Version
6.14.12
Node Version
14.16.1
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
react-native-iconfont-cli
用纯JS把iconfont.cn的图标转换成RN组件，不依赖字体，支持多色彩，支持热更新
痛点
通常地，当我们想在RN里使用iconfont，我们可能会借助react-native-vector-icons导入ttf字体文件，或者直接手动下载各个svg文件到本地，然后单个使用。
使用ttf字体有一个弊端，就是每次更新图标，都要相应的更新ttf文件，然后再次打包发布APP。而且ttf不支持多种色彩的图标，导致所有图标都是单色。如果你是借助react-native-vector-icons，该库内置了10多套ttf文件，合起来有2M左右；你可能用不到它们，但是它们仍然会被打包进你的APP里。
下载svg到本地也不方便，因为你需要额外维护一份图标字体，有可能造成线上和本地的图标不一致问题。而且如果你想动态地改变svg的渲染色彩，基本上是不可能的，只能渲染原图的颜色。
为了解决这些问题，我用纯Javascript实现iconfont到React组件的转换操作，不需要依赖ttf字体文件，不需要手动下载图标到本地。
特性
1、纯组件，不依赖字体，体积小
2、支持渲染多色彩图标，支持自定义颜色
3、支持热更新
4、自动化生成图标组件，支持es6和typescript两种文件格式
Step 1
安装插件
1# Yarn 2yarn add react-native-svg 3yarn add react-native-iconfont-cli --dev 4 5# Npm 6npm install react-native-svg 7npm install react-native-iconfont-cli --save-dev
Step 2
静态链接。请注意您使用的React-Native版本号
1# RN < 0.60 2react-native link react-native-svg 3 4# RN >= 0.60 5cd ios && pod install
Step 3
生成配置文件
1npx iconfont-init
此时项目根目录会生成一个iconfont.json的文件，内容如下：
1{ 2 "symbol_url": "请参考README.md，复制官网提供的JS链接", 3 "use_typescript": false, 4 "save_dir": "./src/iconfont", 5 "trim_icon_prefix": "icon", 6 "default_icon_size": 18, 7 "local_svgs": "./localSvgs" 8}
配置参数说明：
symbol_url
请直接复制iconfont官网提供的项目链接。请务必看清是.js后缀而不是.css后缀。如果你现在还没有创建iconfont的仓库，那么可以填入这个链接去测试：http://at.alicdn.com/t/font_1373348_ghk94ooopqr.js
use_typescript
如果您的项目使用Typescript编写，请设置为true。这个选项将决定生成的图标组件是.tsx还是.js后缀。
当该值为false时，我们会为您的图标生成.js和.d.ts两种文件，以便您能享受到最好的开发体验。
save_dir
根据iconfont图标生成的组件存放的位置。每次生成组件之前，该文件夹都会被清空。
trim_icon_prefix
如果你的图标有通用的前缀，而你在使用的时候又不想重复去写，那么可以通过这种配置这个选项把前缀统一去掉。
default_icon_size
我们将为每个生成的图标组件加入默认的字体大小，当然，你也可以通过传入props的方式改变这个size值。
local_svgs
本地 svg 的路径, 配置此项后在路径中添加 svg 文件即可。支持渐变图标（iconfont官网不能上传渐变图标）。
注 1: 暂不支持 color 参数
注 2: 如果启用该功能，请确保react-native-svg的版本>=9.13.0
Step 4
开始生成React-Native标准组件
1npx iconfont-rn
生成后查看您设置的保存目录中是否含有所有的图标，你可以参考snapshots目录的快照文件，以区分不同模式下的图标结构。
使用
现在我们提供了两种引入方式供您选择：
1、使用汇总Icon组件：
1import IconFont from '../src/iconfont'; 2 3export const App = () => { 4 return ( 5 <View> 6 <IconFont name="alipay" size={20} /> 7 <IconFont name="wechat" /> 8 </View> 9 ); 10};
2、使用单个图标。这样可以避免没用到的图标也打包进App：
1import IconAlipay from '../src/iconfont/IconAlipay'; 2import IconWechat from '../src/iconfont/IconWechat'; 3 4export const App = () => { 5 return ( 6 <View> 7 <IconAlipay size={20} /> 8 <IconWechat /> 9 </View> 10 ); 11};
图标尺寸
根据配置default_icon_size，每个图标都会有一个默认的尺寸，你可以随时覆盖。
1<IconFont name="alipay" size={20} />
图标单色
单色图标，如果不指定颜色值，图标将渲染原本的颜色。如果你想设置为其他的颜色，那么设置一个你想要的颜色即可。
注意：如果你在props传入的color是字符串而不是数组，那么即使原本是多色彩的图标，也会变成单色图标。
1<IconFont name="alipay" color="green" />
图标多色彩
多色彩的图标，如果不指定颜色值，图标将渲染原本的多色彩。如果你想设置为其他的颜色，那么设置一组你想要的颜色即可
1<IconFont name="alipay" color={['green', 'orange']} />
颜色组的数量以及排序，需要根据当前图标的信息来确定。您需要进入图标组件中查看并得出结论。
更新图标
当您在iconfont.cn中的图标有变更时，只需更改配置symbol_url，然后再次执行Step 4即可生成最新的图标组件
1# 修改 symbol_url 配置后执行： 2npx iconfont-rn
欢迎使用，并给我一些反馈和建议，让这个库做的更好
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 2/19 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Reason
66 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-f5x2-xv93-4p23
- Warn: Project is vulnerable to: GHSA-gmpm-xp43-f7g6
- Warn: Project is vulnerable to: GHSA-pf27-929j-9pmm
- Warn: Project is vulnerable to: GHSA-327c-qx3v-h673
- Warn: Project is vulnerable to: GHSA-x4cf-6jr3-3qvp
- Warn: Project is vulnerable to: GHSA-mph8-6787-r8hw
- Warn: Project is vulnerable to: GHSA-7mhc-prgv-r3q4
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-4cpg-3vgw-4877
- Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx
- Warn: Project is vulnerable to: GHSA-7f53-fmmv-mfjv
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-gff7-g5r8-mg8m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
- Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
- Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
- Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
- Warn: Project is vulnerable to: GHSA-h6q6-9hqw-rwfv
- Warn: Project is vulnerable to: GHSA-5fg8-2547-mr8q
- Warn: Project is vulnerable to: GHSA-crh6-fp67-6883
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
1.9
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More