npm 包 mdi-json 使用教程

在前端开发中,我们常常需要使用图标来为网站和应用程序添加更加美观和易于识别的元素。而 Material Design Icons (MDI) 是一个非常流行的图标库,为前端开发提供了丰富的图标资源。mdi-json 是一个可以将 MDI 图标库以 JSON 格式导出的 npm 包,便于前端开发者的使用,本文将为大家介绍如何使用 mdi-json 这个 npm 包。

安装

首先,在终端中使用 npm 安装 mdi-json 包:

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

用法

安装完成后,在项目中引入 mdi-json 包:

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

接下来,就可以使用 mdiJson 对象中提供的 API 来获取 MDI 图标库中的图标数据。

getIconsByKeyword

getIconsByKeyword 方法可以根据关键词搜索匹配的图标,并以 JSON 格式返回图标信息数组。例如,搜索“arrow”关键词并获取匹配到的前 10 个图标数据:

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

输出结果如下:

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

可以看到,返回的数据中包括了每个图标的名称、所在组、Unicode 编码等信息。

getIconByName

getIconByName 方法可以根据图标名称获取对应的图标数据。例如,获取名称为“arrow-left”的图标信息:

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

输出结果如下:

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

getCodeByName

getCodeByName 方法可以根据图标名称获取对应的 Unicode 编码。例如,获取名称为“arrow-left”的图标编码:

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

输出结果为:

----

示例

下面是一个示例代码,展示如何在网页中使用 mdi-json 获取并展示图标:

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

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

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

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

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

以上示例展示了一个搜索框和一个图标列表,当用户输入关键词并提交后,会显示匹配到的图标名称列表。用法上非常简单,只需要调用我们之前介绍的 getIconsByKeyword 方法就可以了。

总结

本文详细介绍了 npm 包 mdi-json 的使用方法,包括获取图标信息和 Unicode 编码,以及如何使用它来在网页中显示图标。这个小工具可以给前端开发者带来很大的效率提升,避免了手动处理 svg 图标的繁琐和复杂操作。希望本文可以对大家有所帮助,谢谢阅读!

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


猜你喜欢

  • npm 包 @mat-datetimepicker/moment 使用教程

    在前端开发中,时间处理一直是一个相当重要的问题。而在 Angular 项目中,使用 @mat-datetimepicker/moment 这个 npm 包可以方便地操作日期和时间。

    5 年前
  • npm包@mat-datetimepicker/core使用教程

    简介 @mat-datetimepicker/core 是一个基于Angular Material的开源日期时间选择器插件。它提供了简单易用的API来展示日期时间选择器,并且支持多种日期时间格式,使用...

    5 年前
  • npm 包 @angular/material-moment-adapter 使用教程

    前言 在 Angular 项目中,使用日期格式化库 Moment.js 可以非常方便地进行日期格式化等操作。而 @angular/material-moment-adapter 就是一个基于 Mome...

    5 年前
  • npm 包@angular/material使用教程

    在现代 Web 开发中,前端技术已经成为了非常重要的一环。在这个领域中,Angular 是非常流行的框架之一,其提供了丰富的组件和功能,进一步提高了开发效率。 而@angular/material 就...

    5 年前
  • npm 包 typescript-styled-plugin 使用教程

    简介 TypeScript 是一种静态类型检查的 JavaScript 语言,用它可以避免一些常见的运行时错误。而 styled-components 是一种 React 组件样式库,它允许你在组件定...

    5 年前
  • npm 包 rollup-plugin-svgo 使用教程

    介绍 rollup-plugin-svgo 是一个基于 svgo 将 SVG 进行压缩和优化处理的 Rollup 插件。通过使用该插件,可以将 SVG 图形文件优化得更小,进而达到优化页面速度的目的。

    5 年前
  • npm 包 @rollup/plugin-alias 使用教程

    在前端开发中,我们通常需要使用外部的库或模块来构建我们的应用程序,尤其是在大型项目中,这种需求更加突出。然而,随着项目的不断扩大和复杂性的增加,我们可能会面临多个依赖库文件名冲突等问题。

    5 年前
  • npm 包 styled-flex-component 使用教程

    在前端开发中,我们经常需要使用 CSS 布局来调整网页的样式。Flexbox 是一种非常强大的 CSS 布局工具,它可以让我们轻松地实现复杂的布局效果。但对于一些不熟悉 Flexbox 的前端初学者或...

    5 年前
  • npm 包 @union/react-schematics 使用教程

    在现代的前端开发中,使用 CLI 工具能够提高研发效率和代码质量。而 Angular CLI 便是一个很好的例子。随着 React 生态不断壮大,React CLI 工具也愈发重要。

    5 年前
  • npm 包 @types/styled-system__theme-get 使用教程

    简介 在进行前端开发时,可以借助 Styled System 实现样式定义与应用的高效管理。而 @types/styled-system__theme-get 就是一个用来在 Styled Syste...

    5 年前
  • npm 包 @types/styled-system 使用教程

    在前端开发领域,css 是一个非常重要的技术点。而在大型项目中,管理 css 变得越来越复杂。为了更好地管理 css,我们有一个非常流行的工具叫做 styled-component。

    5 年前
  • npm 包 @types/react-modal 使用教程

    前言 在前端开发中,我们经常会使用到各种 npm 包来提升开发效率,其中 @types/react-modal 就是一个优秀的类型声明库。它提供了 React Modal 组件的类型定义,使我们在使用...

    5 年前
  • npm 包 @stencil/react-output-target 使用教程

    Stencil 是一款 Web 组件库,由 Ionic Team 推出,可以编写 Web 组件并在多个框架中使用。其中,@stencil/react-output-target 是Stencil中的一...

    5 年前
  • npm 包 rfs 使用教程

    在前端开发中,响应式设计越来越普及,如何处理文本以适应不同大小的屏幕是每个 web 开发人员需要处理的问题之一。而 rfs 库则是专门解决响应字体大小的问题,本篇文章将介绍如何使用 rfs 库来实现响...

    5 年前
  • npm 包 mobile-select 使用教程

    前言 在移动设备上,我们经常需要使用下拉选择框来让用户选择一个选项。mobile-select 是一个针对移动设备的下拉选择框库,它提供了多种风格样式的下拉选择框,并且使用简单方便。

    5 年前
  • npm 包 nouislider 使用教程

    前言 在前端开发中,我们经常需要使用到各种各样的 UI 组件来满足我们的需求。nouislider 是一个可以用来实现滑块组件的 npm 包,它可以让用户通过滑块来选择范围,进行取值等操作。

    5 年前
  • npm 包 @types/nouislider 使用教程

    在前端开发中,我们通常需要使用各种 JavaScript 库和框架来进行快速开发。在这个过程中,我们常常会使用 npm 包管理器来安装和管理这些库。而在使用这些库时,通常需要对其进行类型声明以方便开发...

    5 年前
  • npm 包 @types/lodash.throttle 使用教程

    在前端开发中,使用lodash.throttle可以控制函数触发频率,进而提高网站性能。@types/lodash.throttle是lodash.throttle的typescript类型定义库,可...

    5 年前
  • npm 包 @types/dom-inputevent 使用教程

    简介 在前端开发中,我们经常需要获取用户输入的值,而用户输入可能是鼠标点击、键盘输入等,其中键盘输入又分为字符输入和按键输入。为了更方便地处理这些事件,JavaScript 提供了 InputEven...

    5 年前
  • npm 包 @clxx/base 使用教程

    简介 @clxx/base 是一个前端基础库,提供了一些常用的工具函数和方法,可以辅助开发者更高效地进行开发。该包可以通过 npm 安装和使用。 安装 使用 npm 进行安装: --- -------...

    5 年前

相关推荐

    暂无文章