npm 包 @svgr/rollup 使用教程

背景

SVG 是一种矢量图形标准,它的优点就是可以在任意尺寸下无失真,而缺点则是难以编辑和交互。由于在前端中,尤其是在 React 应用中使用 SVG 的需求量越来越大,因此产生了一些 SVG 编辑器和转换器。

其中一个使用最广泛的是 @svgr/core,它可以将 SVG 转换为 React 组件。当然,如果需要在 Rollup 构建环境下使用它,还需要使用 @svgr/rollup 这个 npm 包来进行转换和优化。因此,本文将介绍如何使用 @svgr/rollup 这个 npm 包来构建 Rollup 环境下的 SVG 转换。

安装

首先,我们需要安装 @svgr/core@svgr/rollup 这两个 npm 包:

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

我们还需要安装 rollup-plugin-svgr 这个 Rollup 插件来将 SVG 文件转换为 React 组件:

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

使用

在 Rollup 配置文件中,我们需要引入 rollup-plugin-svgr 并配置它:

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

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

这样,我们就可以在 Rollup 环境下使用 @svgr/core 来转换 SVG 文件,并将它们作为 React 组件打包到我们的应用中了。

指南

  1. 在 SVG 文件中添加 <svg> 标签

    在使用 @svgr/rollup 转换 SVG 文件时,它会将整个 SVG 图像都解析为 React 组件。因此,我们需要在 SVG 文件中添加 <svg> 标签来确保整个图像都能被转换:

    ---- ---------------------------------- ---------- ----------- ---------- - -- ----
      ---- --- -- --- -- --- ---
    ------
  2. 使用 svgrProps 属性来配置生成的组件

    我们可以在 SVG 文件中使用 svgrProps 属性来配置生成的组件。例如,我们可以添加一个 title 属性来为 SVG 图像添加标题:

    ---- ---------------------------------- ------------ ------ --- --- ------ -- ---------- - -- ----
      ---- --- -- --- -- --- ---
    ------
  3. 使用 svgrOptions 对象来配置 @svgr/core 的选项

    我们可以使用 svgrOptions 对象来配置 @svgr/core 的选项。例如,我们可以将 svgrOptions.dimensions 设置为 false 来禁用自动计算 SVG 图像的宽度和高度:

    ------
      ------------ -
        ----------- ------
      --
    ---
  4. 在项目中使用转换后的组件

    当 SVG 文件被转换为 React 组件后,我们可以像使用任何其他 React 组件一样来使用它们。例如,在 React 组件中使用转换后的 SVG 组件:

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

示例代码

在本示例代码中,我们将一个 SVG 图像转换为 React 组件,并在 Rollup 环境下打包它们。

SVG 文件

我们的 SVG 文件包含一个简单的圆形,如下所示:

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

React 组件

在 React 组件中,我们导入转换后的 SVG 组件,并将它们渲染到页面上:

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

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

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

Rollup 配置文件

在 Rollup 配置文件中,我们需要使用 rollup-plugin-svgr 来转换 SVG 文件,并将生成的组件打包到输出的 JavaScript 文件中:

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

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

结语

在本文中,我们介绍了如何使用 @svgr/core@svgr/rollup 这两个 npm 包来在 Rollup 环境下进行 SVG 转换。我们还提供了一些使用指南和示例代码,希望这篇文章能够帮助你更好地理解和应用这些技术。

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


猜你喜欢

  • npm包cssnano-cli使用教程

    前言 随着前端开发的日新月异,我们经常使用各种各样的工具和框架来协助我们完成开发工作。其中,npm包是前端开发中的重要组成部分。npm包能够帮助我们快速完成各种任务,包括代码压缩、文件合并等,这大大提...

    5 年前
  • npm 包 mozilla-deferred 使用教程

    前言 在前端开发中,我们经常会在异步操作中遇到回调函数的问题。而使用 mozilla-deferred 这个 npm 包,可以让我们更方便地处理回调函数的问题,提高开发效率,减少代码量。

    5 年前
  • npm 包 is-auto-orienting 使用教程

    什么是 is-auto-orienting? is-auto-orienting 是一个用于前端开发的 npm 包,其主要作用是自动根据图片的 Exif 信息调整图片的方向。

    5 年前
  • npm 包 exif-rotate 使用教程

    当我们使用手机或数码相机拍摄照片时,照片会包含一些元数据(metadata)信息,其中就包含了拍摄方向。但是有些情况下,我们并不想以该方向展示照片,这时就需要对照片进行旋转。

    5 年前
  • npm包@mqschwanda/safe-get-nested-object使用教程

    前言:在前端开发中,经常会遇到需要获取嵌套对象中的值的场景,但有时会遇到空引用异常等问题,这时就需要使用一些库来避免这些问题。本文介绍了一个 npm 包 @mqschwanda/safe-get-ne...

    5 年前
  • npm包@queuetue/feathers-authentication-key使用教程

    在前端开发中,认证和授权一直是关键的问题,然而,这一领域涉及的技术点较多,学习难度相对较高。而npm包@queuetue/feathers-authentication-key可以帮助开发者轻松实现认...

    5 年前
  • npm 包 @feathers-nuxt/feathers-rest-proxy 使用教程

    简介 @feathers-nuxt/feathers-rest-proxy 是一个可以帮助我们将一个已有的 Feathers REST 服务代理到 Nuxt.js 应用中的 npm 包。

    5 年前
  • npm 包 @eservices/servicebot 使用教程

    在前端领域,构建聊天机器人已经成为了一个越来越受欢迎的需求。然而,构建聊天机器人需要复杂的算法和架构,难以轻易地被突破。因此,很多团队都在寻找最便捷且高效的方法来构建聊天机器人,而 @eservice...

    5 年前
  • npm 包 feathers-sync 使用教程

    介绍 Feathers-sync 是一个配套 Feathers.js 的实时数据同步工具,它可以帮助我们在实现前端实时数据同步时能更加方便地操作服务端,而无需后端工程师参与。

    5 年前
  • npm 包 @yawetse/socket.io-adapter-mongo 使用教程

    前言 Socket.io 提供了 Adapter 接口,可以让开发者使用各种 NoSQL 数据库来存储 WebSocket 的会话信息。在这个方案中,我们将介绍 @yawetse/socket.io-...

    5 年前
  • npm 包 @omneedia/socket.io-adapter-mongo 使用教程

    简介 @omneedia/socket.io-adapter-mongo 是基于 mongodb 开发的 socket.io 适配器。它使 socket.io 实例可以通过 mongodb 集合进行共...

    5 年前
  • npm 包 @kalisio/krawler 使用教程

    简介 npm 是前端开发中一个重要的工具,它允许我们管理依赖,构建和打包项目等等。其中,@kalisio/krawler 是一个非常实用的 npm 包,它可以帮助我们爬取网页数据,提取网页信息,以及自...

    5 年前
  • npm包 @gitterhq/passport-github使用教程

    简介 在前端开发中,有时需要实现通过Github账号进行用户认证的功能。为了实现这一功能,我们可以使用npm包 @gitterhq/passport-github。

    5 年前
  • npm 包 rhtml 使用教程

    rhtml 是一个能够将 R 代码转换成 HTML 输出的 npm 包,该包在前端开发中非常常见,特别是在数据可视化领域中。本文将介绍如何使用 rhtml 包进行 R 代码的转换操作。

    5 年前
  • NPM 包 @byzantine-lab/keyring-controller 使用教程

    @byzantine-lab/keyring-controller 是一个 JavaScript 库,旨在提供一个简单的 API 来管理不同身份的密码。它可以用于前端开发中,特别是在需要管理多个账号的...

    5 年前
  • npm 包 metamascara 使用教程

    简介 metamascara 是一个使用 HTML/CSS 实现的 UI 库。它提供了大量的组件,可以帮助你快速构建出漂亮的 Web 应用。同时,它的使用也很简单。

    5 年前
  • npm 包 @toruslabs/torus-embed 使用教程

    在前端开发中,我们经常需要使用第三方库来实现一些功能。而 npm 是当前最为流行的 JavaScript 包管理器之一,让我们能够更加方便地安装、管理和更新第三方库。

    5 年前
  • npm 包 @dexon-foundation/dekusan-inpage-provider 使用教程

    在以太坊生态系统中,MetaMask 是最常见的钱包插件之一,它可以与不同的 dApp 集成,但限定只能在以太坊网络上运行。而 @dexon-foundation/dekusan-inpage-pro...

    5 年前
  • npm 包 browser-stdout 使用教程

    1. 简介 browser-stdout 是一个 NPM 包,它提供了类似于 Node.js 的 console 对象的 stdout 方法,在 Web 浏览器中可以方便地进行日志记录和调试操作。

    5 年前
  • npm 包 post-message-stream 使用教程

    前言 前端开发中的需求多种多样,其中涉及到不同窗口之间通讯的需求也比较常见。而其中通过 postMessage 实现的通讯需求也十分普遍。然而若要实现两端窗口间的通讯,不仅需要注意消息格式的合法性,也...

    5 年前

相关推荐

    暂无文章