npm 包 gulp-icomoon-builder 使用教程

在前端开发中,icon 是不可缺少的一个元素。在项目中,我们往往会选择使用 IcoMoon 字体库来管理和使用 icon,本文将介绍如何使用 npm 包 gulp-icomoon-builder 来自动生成 IcoMoon 字体库。

1. 安装 gulp-icomoon-builder

在终端中进入项目的根目录,执行以下命令:

--- ------- -------------------- ----------

2. 下载 IcoMoon 的字体文件

IcoMoon 官网 创建一个项目,选择需要的 icon,然后点击右上角的“Generate Font”按钮,下载压缩包。解压后可以得到以下文件:

  • fonts/icomoon.eot
  • fonts/icomoon.svg
  • fonts/icomoon.ttf
  • fonts/icomoon.woff

将这些文件复制到项目的某个目录下,例如 src/assets/fonts。

3. 配置 gulpfile.js

在项目的根目录中创建 gulpfile.js,加入以下代码:

--- ---- - ----------------
--- -------- - -------------------------
--- ----------- - -----------------------------
--- ------------ - --------------------- - ------

--------------------- -----------
  ------ ------------------------------------
  -------------------
    --------- ----------
    ----- ----------------------------------
    ----------- --------------------------------
    --------- -----------
  ---
  ----------------
    --------- ----------
    --------------- -----
    -------- -------- -------- ------ ------ -------
    ---------- ------------
   ---
  --------------------------------------
---
  • 第 1 行:引入 gulp 模块。
  • 第 2 行:引入 gulp-iconfont 模块,用于生成字体文件。
  • 第 3 行:引入 gulp-iconfont-css 模块,用于生成 css 文件。
  • 第 4 行:用于获取当前时间戳,作为字体版本号。
  • 第 6 行:定义一个任务名为“iconfont”。
  • 第 8 行:从指定目录中读取所有的 .svg 文件。
  • 第 9~14 行:使用 gulp-iconfont-css 生成 css 文件,其中 fontName 为生成的字体名称,path 为包含 css 模板信息的文件路径,targetPath 为生成的 css 文件的相对路径,fontPath 为字体文件的相对路径。
  • 第 16~26 行:使用 gulp-iconfont 生成字体文件,其中 fontName 为字体的名称,prependUnicode 表示是否在 Unicode 前面加上反斜杠,formats 表示生成的字体格式,timestamp 表示字体的版本号。
  • 第 27 行:指定字体文件的输出目录。

4. 创建 css 模板文件

在 src/assets/templates 目录下创建 _icons.css 文件,输入以下代码:

---------- -
  ------------ ----------
  ----  -----------------------------------------------
  ----  ---------------------------------------------------- ----------------------------
    ---------------------------------------------- -------------------
    ----------------------------------------------- ---------------
    ------------------------------------------------------ --------------
  ------------ -------
  ----------- -------
-

----------------- --------- ------- -
  -- --- ---------- -- ------- ------ ---- ------- ---------- ---- ------ ----- --
  ------------ --------- -----------
  ------ ------
  ----------- -------
  ------------ -------
  ------------- -------
  --------------- -----
  ------------ --
  ----------------------- ------------
  ------------------------ ----------
-

----------------- -
  -------- --------
-

其中:

  • font-family 表示生成的字体名称。
  • src 为字体文件的地址,其中 [[fontPath]] 和 [[timestamp]] 分别会被 gulp-iconfont-css 插件替换成实际值。
  • [class^="icon-"], [class*=" icon-"] 表示所有类名以“icon-”开头或包含“ icon-”的元素都使用这个字体。
  • .icon-home:before 表示将 icon 的类名“icon-home”对应的字符设置为实际图标。

5. 使用

执行以下命令:

---- --------

便可在 src/assets/fonts 目录下生成以下文件:

  • icomoon.eot
  • icomoon.svg
  • icomoon.ttf
  • icomoon.woff
  • icomoon.woff2

并在 src/stylesheets 目录下生成 _icons.scss 文件,其中包含了所有图标的类名和对应字符的设置。在项目中只需要引入 _icons.scss 文件即可。

例如项目的 index.html 文件中使用“icon-home”图标:

------
  ------
    -------------------
    ----- ---------------- -----------------------------
  -------
  ------
    ---- ------------------------
  -------
-------

在 stylesheets/index.css 文件中加入:

------- --------

便可使用图标。

总结

使用 gulp-icomoon-builder 可以自动生成 IcoMoon 字体库,前端开发者无需手动生成和维护字体文件和 css 文件,极大地提高了开发效率。通过本文的学习,相信读者已经会使用 gulp-icomoon-builder 了。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055eb781e8991b448dc69c


猜你喜欢

  • npm 包 jest-object 使用教程

    jest-object 是一个方便的 npm 包,可以帮助你在 Jest 测试框架中更容易地编写对象类型的测试用例。本文将为大家详细介绍该 npm 包的使用方法,包括安装、引入、基本语法以及示例。

    2 年前
  • NPM 包 ndfo 使用教程

    简介 当我们在开发前端项目时,经常会使用到各种各样的第三方库。这些库中很多都是通过 NPM (Node Package Manager) 来管理和发布的,而我们则可以通过 NPM 来轻松地获取这些库并...

    2 年前
  • npm 包 nol 使用教程

    前言 在前端开发中,我们经常需要处理数字和字符串的格式化,比如将一个数字用逗号分隔千位数、将一个日期转换为指定格式的字符串等。而 nol 作为一个小巧、功能强大的 npm 包,能够帮助我们轻松地完成这...

    2 年前
  • NPM 包 none-dux 使用教程

    简介 在现代的前端开发中,状态管理已经成为了必不可少的一环,而 Redux 作为最流行的状态管理库之一,应用广泛。但是对于小型项目或者对 Redux 不太熟悉的开发者来说,使用 Redux 进行状态管...

    2 年前
  • npm 包 redux-action-handlers 使用教程

    如今,在前端开发领域,Redux 已经成为了不可或缺的一个状态管理框架。在 Redux 中,reducer 所扮演的角色非常重要,而 reducer 的可复用性则取决于是否能够合理地归纳 action...

    2 年前
  • npm 包 pineapplejs 使用教程

    在现代 web 开发中,使用 npm 包来管理 JavaScript 的依赖关系成为了标配,npm 包的数量和质量也在不断提升。今天我们要介绍的是一个非常优秀的 npm 包 pineapplejs,它...

    2 年前
  • npm 包 trove-api-archiver 使用教程

    引言 在前端开发中,我们经常会用到一些网络服务接口来获取数据,而这些获取到的数据通常都需要进行存储和备份,以防止数据在传输和处理过程中出现不可预料的问题。trove-api-archiver 就是一款...

    2 年前
  • npm 包 state-pass 使用教程

    介绍 state-pass 是一个用于状态管理的 JavaScript 库,可用于 Web 应用和 Node.js 服务器端。该包提供多种灵活的方式来处理应用程序的状态。

    2 年前
  • npm 包 generator-gorila-app 使用教程

    在现代的 Web 开发中,使用工具和框架可以大幅提高开发效率和代码可读性,npm 包就是其中一个重要的工具。generator-gorila-app 是一个名叫 Gorila 的前端脚手架工具,可以帮...

    2 年前
  • npm 包 mjml-section-bg-img 使用教程

    在前端开发中,制作邮件模板往往是一件比较让人头疼的事情。而 mjml-section-bg-img 就是一款可以让制作邮件模板变得更加轻松的 npm 包。 本文将为大家详细介绍如何使用 mjml-se...

    2 年前
  • npm 包 select2-taiton 使用教程

    select2-taiton 是一个非常有用的 npm 包,它可以帮助我们实现一个优美、功能强大的下拉选择框。它支持多选、搜索、选择项追加等特性,并且非常方便易用。

    2 年前
  • npm 包 sprite-loader 使用教程

    在前端开发中,优秀的图像处理方式可以提高页面性能,减轻服务器负担。使用 sprite 组合多个小图标可以有效减少 http 请求次数,提高页面性能。本文将介绍 npm 包 sprite-loader ...

    2 年前
  • npm 包 assoclist.js 使用教程

    简介 assoclist.js 是一款 npm 包,它提供了一个列表 (associative list) 的数据结构,可让前端开发者更轻松地存储和处理键值对。该包提供了一组函数,可以方便地对列表进行...

    2 年前
  • npm包 gh-diff-html 使用教程

    如果你需要展示GitHub上两个提交之间的差异,那么 gh-diff-html 就是一个非常好的npm包。它可以方便快捷地生成HTML格式的差异对比,而不需要你自己写大量的代码去处理差异对比。

    2 年前
  • npm 包 glyo 使用教程

    在前端开发中,我们经常需要使用图标来装饰网站,但是手写 icon 效率低、不易修改,因此经常使用成套的图标库。 在这里,我们介绍一种非常实用的 npm 包 glyo,它支持数千种图标,而且还可以自定义...

    2 年前
  • npm 包 lee-mmetronic 使用教程

    前言 npm 是前端开发者必备的一个工具,可以方便地管理项目所需的第三方依赖库。然而,市面上的 npm 包数量众多,有没有一个能够提高开发效率,且美观、易用的 npm 包呢?没错,lee-mmetro...

    2 年前
  • npm 包 aws-data-lake-sdk 使用教程

    npm 包 aws-data-lake-sdk 使用教程 AWS Data Lake 是 AWS 上一种用于存储和分析无结构数据的存储服务。aws-data-lake-sdk 是一个 NPM 包,它提...

    2 年前
  • npm 包 react-native-caroussel-pager 使用教程

    介绍 react-native-caroussel-pager 是一个 React Native 的轮播图组件。它可以实现多张图片的水平滑动切换,支持自动播放、无限循环、手势滑动等功能。

    2 年前
  • npm包`react-responsive-comments`使用教程

    介绍 react-responsive-comments 是一个开源、易于使用,能够响应不同大小设备屏幕的 React 组件库。它提供了一个定制化的评论系统,主要特点有: 响应式设计:自动适应屏幕大...

    2 年前
  • npm 包 cerebro-yandex-translate 的使用教程

    在前端开发中经常需要对多种语言进行翻译,而人工翻译无疑是一项耗时费力的工作。这时候就需要借助机器翻译来快速解决这个问题。Yandex Translate 是目前比较好用的机器翻译平台之一,而 cere...

    2 年前

相关推荐

    暂无文章