简介
neicon-tool 是一个基于 Node.js 的 npm 包,主要用于在前端开发中帮助使用者快速生成 Iconfont 图标库的字体文件。
使用 neicon-tool 可以避免手动下载字体库、手动生成字体文件等繁琐的操作,大大提高了前端开发的效率。
安装
安装 neicon-tool 很简单,只需要使用 npm 命令进行安装即可:
npm install neicon-tool --save-dev
使用教程
1、创建字体库
在使用 neicon-tool 之前,首先需要准备好自己的字体文件。
neicon-tool 支持 ttf、svg、woff、eot 这四种常用的字体格式,可以根据实际需求选择相应的格式。例如,我们有一些 SVG 格式的图标文件,需要将它们转换成字体文件。
首先,在项目根目录下新建一个名为 iconfont 的目录,然后将 SVG 图标文件放在此目录下,目录结构如下所示:
project └── iconfont ├── icon-a.svg ├── icon-b.svg └── icon-c.svg
接下来,使用终端进入到 iconfont 目录中,执行以下命令:
neicon-tool init
该命令将生成一个名为 iconfont.json 的配置文件,用于配置字体库的相关参数,如下所示:
-- -------------------- ---- ------- - ------------- ----------- ------------ ----- ------------- ----- ----------- ----------- ------------ ------- --------------- ----- ------------------ ------ -
这些参数的含义解释如下:
fontFamily
:字体族名,建议设为 iconfont,和项目名字一致;fontWidth
:字体文件宽度,默认为 1024,建议不要修改,否则可能影响图标的显示效果;fontHeight
:字体文件高度,默认为 1024,建议不要修改,否则可能影响图标的显示效果;fontName
:生成的字体文件名,建议设为 iconfont;cssPrefix
:生成的 CSS 类名前缀,建议设为 icon;svgIconsPath
:SVG 图标文件所在的相对路径,默认为当前目录,即 ./;svgIconsPattern
:SVG 图标文件的匹配规则,默认为 .svg,即匹配所有后缀名为 .svg 的图标。
以上参数均可以根据项目需求进行修改。
修改完毕后,执行以下命令生成字体文件:
neicon-tool build
执行该命令后,将在 iconfont 目录下生成以下文件:
-- -------------------- ---- ------- ------- --- -------- --- ---------- --- ---------- --- ---------- --- ------------ --- ------------ --- ------------- --- ------------ --- -------------
其中,iconfont.css 文件是样式文件,包含了所有 SVG 图标对应的字体类名和 Unicode 编码。
2、使用字体库的图标
将生成的字体库文件复制到项目对应的目录中,如下:
-- -------------------- ---- ------- ------- --- -------- - --- ---------- - --- ---------- - --- ---------- - --- ------------ - --- ------------ - --- ------------- - --- ------------ - --- ------------- --- --- --- --------
然后,在 HTML 文件中添加以下代码:
<link rel="stylesheet" href="./iconfont/iconfont.css">
接着,在需要使用图标的元素中添加以下 HTML 代码:
<i class="icon icon-a"></i> <i class="icon icon-b"></i> <i class="icon icon-c"></i>
其中,class 属性中的 icon-a、icon-b、icon-c 分别对应配置文件中的 SVG 图标文件名。
最终,在浏览器中打开 HTML 文件,可以看到图标已经成功渲染出来了。
3、扩展字体库
如果在上述生成字体库的过程中又新加了一些 SVG 图标,直接再次执行以下命令即可更新字体库:
neicon-tool build
4、其他命令
除了上述介绍的两个命令外,neicon-tool 还提供了其他一些有用的命令,如下:
neicon-tool watch
:监听 SVG 图标文件的变化,自动更新字体库;neicon-tool preview
:在浏览器中预览字体库中的图标;neicon-tool clean
:删除生成的字体文件和样式文件。
总结
neicon-tool 是一个非常实用的前端开发工具,可以帮助使用者快速生成字体库,避免了一些繁琐的操作。
希望本教程对大家有所帮助。如有疑问或意见,可以在评论区留言。谢谢阅读!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005725881e8991b448e8753