npm 包 brander 使用教程

在前端开发中,随着前端框架、库等工具的快速发展,npm 包的使用已经成为一项必备技能。在一些较大的项目开发中,如果没有合适的 npm 包,我们无法快速实现需求。今天,我们来介绍一个非常实用的 npm 包:Brander。

什么是 Brander?

Brander 是一个开源 npm 包,其可以快速地生成 SVG 图标,并返回 SVG 和 PNG 格式。比如,我们可以使用它来实现在我们的 React / Vue / Angular 项目中添加自定义的 SVG 图标。

Brander 的安装

我们可以使用 npm 命令来安装 Brander:

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

Brander 的使用方法

我们可以使用 Brander 的 JS API 或者命令行工具来生成 icon。

1. 使用 JS API

创建实例

在使用 Brander 之前,我们需要先创建一个 Brander 实例:

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

这里,我们使用 brander 导入 Brander 包,然后使用 brander 函数创建一个 Brander 实例。在这个过程中,我们需要提供一些配置项:

  1. color:SVG 图标的颜色;
  2. background:SVG 图标的背景色;
  3. url:SVG 图标的链接。

值得一提的是,这里的 brander 函数会返回一个 Brander 实例,我们可以使用这个实例来调用其他方法。

生成 icon

Brander 实例创建完成之后,我们就可以使用 icon() 方法来生成 icon 了:

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

这里,我们使用 icon() 方法来生成 icon。在生成 icon 的时候,我们需要提供一些配置项:

  1. name:生成 icon 的名称;
  2. width:生成 icon 的宽度;
  3. height:生成 icon 的高度;
  4. type:生成 icon 的类型(必须为 svg 或者 png)。

值得一提的是,这里,我们使用 instance 实例调用了 icon() 方法,生成的 icon 会被保存到 icon 变量中。

输出 icon

最后,我们需要使用 toString() 方法,将生成的 icon 输出:

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

这里,我们使用 console.log() 方法输出 icon。

2. 使用命令行工具

安装命令行工具

Brander 包提供了一个方便的命令行工具 Brander-cli,我们可以使用以下命令来安装:

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

生成 icon

安装完成之后,我们就可以使用 Brander-cli 命令行工具来生成 icon 了:

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

在这个命令行中,我们需要提供一些参数:

  1. n, --name:生成图标的名称;
  2. w, --width:生成图标的宽度;
  3. h, --height:生成图标的高度;
  4. t, --type:生成图标的类型,必须为 svg 或者 png
  5. c, --color:生成图标的颜色;
  6. b, --background:生成图标的背景颜色;
  7. u, --url:生成图标的链接。

输出 icon

最后,我们需要将生成的 icon 输出到文件中:

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

在这个命令行中,我们使用 brander output 命令将 icon 输出到 icon.png 文件中。

Brander 的示例

下面,我们来看一个实际应用的例子,使用 Brander 快速生成一个 Gihub Icon。

1. 使用 JS API

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

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

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

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

在这个例子中,我们生成了一个 github 名称的名为 20*20 的 PNG 图标,并输出到控制台。

2. 使用命令行工具

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

在这个例子中,我们使用命令行工具生成了一个 github 名称的名为 20*20 的 PNG 图标,并将它输出到 icon.png 文件中。

总结

Brander 是一个非常实用的 npm 包,它可以帮助我们快速生成 SVG 和 PNG 图标,使我们在前端开发中实现快速且自定义的 icon 以及设计。当然,我们也可以根据自己的需求来修改 Brander 的配置,从而实现更加个性化的 icon。祝大家在开发过程中使用 Brander 更加愉快!

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


猜你喜欢

  • npm 包 brander-gulp-tasks 使用教程

    简介 brander-gulp-tasks 是一个基于 gulp 的前端自动化构建工具的 npm 包,可以帮助开发者快速构建和打包项目,支持常见的前端技术,如:es6、scss、pug 等,同时也支持...

    4 年前
  • npm 包 brandicons 使用教程

    在前端开发中,我们经常需要使用一些图标来美化页面或者用作交互元素。npm 包 brandicons 是一个非常好用的 CSS 图标库,它提供了多种高质量的品牌图标,这些图标都可以非常方便地在页面中使用...

    4 年前
  • npm包bp-angular-credit-cards使用教程

    什么是bp-angular-credit-cards? bp-angular-credit-cards是一个AngularJS模块,用于在前端实现信用卡表单验证和显示卡片效果。

    4 年前
  • npm 包 bower-dependencies-collector 使用教程

    前言 在项目中,我们经常需要借助第三方库来增强我们的功能。而这些库通常以 npm 包或者 Bower 增加了我们的依赖树,依赖的管理变得越来越困难。bower-dependencies-collect...

    4 年前
  • npm包bower-dependencies-resolver使用教程

    简介 bower-dependencies-resolver是一个npm包,它为前端开发人员提供了一种自动解决bower依赖关系的方法。它会自动找到并获取bower配置文件,并安装所有相关依赖项。

    4 年前
  • npm 包 bower-deploy 使用教程

    在前端开发的过程中,我们经常需要使用各种第三方库来完成我们的工作。而这些第三方库通常都通过包管理工具进行安装和管理。npm 是 Node.js 的包管理工具,而 bower 则是专门为前端开发设计的包...

    4 年前
  • npm包:bower-dependency-tree使用教程

    在前端开发中,我们常常会使用到第三方库和插件。为了快捷方便地管理这些外部依赖,我们通常会使用一个叫做bower的包管理器。但是,随着项目变得越来越复杂,管理这些依赖关系也变得越来越困难。

    4 年前
  • npm 包 HTML Entity Decoder 使用教程

    在前端开发中,我们常常会遇到需要将 HTML 实体编码转化为常规文本的需求。比如说,我们可能需要将代码中的 < 转化成 <,将 & 转化成 & 等等。

    4 年前
  • npm 包 borschik-tech-csso 使用教程

    什么是 borschik-tech-csso borschik-tech-csso 是一个基于 csso 的前端工具,能够对 CSS 文件进行压缩和优化,使得 CSS 文件更加精简并提升网页的渲染速度...

    4 年前
  • npm包 borschik-tech-csso-next 使用教程

    一、前言 在前端开发中,CSS的压缩和优化是常见的需求。本文介绍一个基于csso(A CSS minifier)的npm包:borschik-tech-csso-next,通过它可以对CSS进行压缩和...

    4 年前
  • npm 包 bower-check-updates 使用教程

    前言 如果你正在使用 bower 管理你的前端依赖库,可能会碰到这样的情况:当你在使用一个版本较老的依赖库时,你的应用程序可能不能与最新版本的浏览器兼容。如果你想要解决这个问题,你需要手动检查每个库的...

    4 年前
  • npm Package BoxyJS 使用教程

    在前端开发中,我们常常需要实现一些与盒子有关的功能,比如生成一个可以缩放、拖拽的盒子,或者计算两个盒子的碰撞、重叠等问题。这时候,一个名为 BoxyJS 的 npm 包就可以派上用场了。

    4 年前
  • npm 包 bower-complete 使用教程

    介绍 bower-complete 是一个 NPM 包,可以帮助前端开发者完成类似于 Bash 中的命令补全的功能。它可以减少开发过程中由于单词拼写错误等问题带来的麻烦,提高开发效率。

    4 年前
  • npm 包 bower-conflict 使用教程

    在前端开发过程中,我们经常使用包管理工具来安装和管理项目所需要的依赖包。其中,npm 和 bower 是两个非常流行的包管理工具,但是它们之间有时会出现依赖包的冲突问题,为了解决这个问题,我们可以使用...

    4 年前
  • npm 包 bower-conflict-view 使用教程

    简介 在前端开发中,我们常常使用 bower 进行包管理,但是当我们使用不同的项目、不同的工具或者不同的团队协作时,可能会出现 bower 包冲突的问题。当我们在项目中引入不同版本的同一个包或者同一个...

    4 年前
  • npm 包 bp-router-core 使用教程

    在前端开发过程中,很多时候需要实现路由跳转的功能。npm 包 bp-router-core 就是一个可以方便地帮助我们实现路由跳转的工具。 在本篇文章中,我们将详细介绍如何使用 npm 包 bp-ro...

    4 年前
  • npm 包 bp-sideburns 使用教程

    介绍 bp-sideburns 是一个基于 Bootstrap 的侧边栏组件库。它提供了多种样式和可定制的选项,可以帮助开发者快速搭建侧边栏。 安装 bp-sideburns 可以通过 npm 进行安...

    4 年前
  • npm 包 bp-utilities 使用教程

    简介 bp-utilities 是一个前端工具包,提供了很多好用的工具类方法,帮助开发者在项目中快速、高效地实现各种需求。它基于 ES6+,提供了类型安全的函数和方法,且具有良好的兼容性和可扩展性。

    4 年前
  • npm 包 bp.js 使用教程

    简介 bp.js 是一个用于浏览器端构建神经网络的 JavaScript 库。它提供了多种常用的神经网络模型,并且支持自定义模型,可以方便快捷地搭建自己想要的神经网络模型。

    4 年前
  • npm 包 bp_cookie 使用教程

    前言 在前端开发中,我们经常需要在浏览器端保存用户的登录状态、设置一些用户偏好等信息。为了方便在代码中操作浏览器的 cookie 数据,我们可以使用 npm 包 bp_cookie。

    4 年前

相关推荐

    暂无文章