vue-cli3 svg组件封装

分手后的思念是犯贱 2023-06-27 05:40 12阅读 0赞

## 背景 ##

> 项目当中使用icon应该是很多的，比如说菜单的图标等等，其实方法有很多，我们可以使用字体图标，我们可以使用png图片等，但是他们都有弊端，我们一般都会结合阿里图标库。

### 一.使用字体图标,png的弊端 ###

*  字体图标库 以找字体费劲，如果我们使用阿里图标库，当我们又使用新的图标的时候我们需要重新下载文件引入，有时候可能名称会变，很容易影响之前的使用
 *  png图片 多了就会是项目变大(虽然没多大)一种意识性问题

### 二.如何封装svg组件 ###

我们为什么要封装一个svg组件呢？我们想要的结果是，我们可以下载svg文件，然后组件里的某一个属性传入svg文件的名称，然后渲染出来我们想要的图标，比如 `<svg-icon icon-class="agent"></svg-icon>` ，好处就是使用方便，我们还可以修改svg的大小，颜色，简直就是神奇，还不占用太多资源，完美，下面我们就说一下该如何实现(ps: 百度一搜，一堆叫你实现的文章，安装步骤完成就行)以及坑，或者说配合 `vue-cli3` 的坑？？？？？

#### 2.1 准备工作 ####

##### 2.1.1 组件目录结构 #####

|-- icons // 文件夹  
| – svg // 文件夹 用来存放svg文件  
| – index.js  
| – SvgIcon.vue

##### 2.1.2 需要的loader #####

yarn add svg-sprite-loader -D

##### 2.1.3 vue.config.js #####

// 删除其他loader对svg文件的编译
    config.module.rules.delete("svg")
    config.module
      .rule('svg-smart')
      .test(/\.svg$/)
      .include
      .add(resolve('src/icons'))
      .add(resolve('src/assets'))
      .end()
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({ 
      symbolId: 'icon-[name]'
    })

#### 2.2 详解icons文件夹 ####

##### 2.2.1 svg文件夹 #####

这是一个 `文件夹` 专门用来存放项目里面需要使用的svg文件，比如 `a.svg` `b.svg` …

##### 2.2.2 index.js #####

每行代码啥意思自行百度，不再去详细解释。

import Vue from 'vue'
    import SvgIcon from './SvgIcon'// svg组件
    
    // 全局注册组件
    Vue.component('svg-icon', SvgIcon)
    
    const req = require.context('./svg', false, /\.svg$/)
    const requireAll = requireContext => requireContext.keys().map(requireContext)
    console.log('requireAll', requireAll(req))
    requireAll(req)

##### 2.2.3 SvgIcon.vue #####

就是普通的vue组件，不再解释。

<template>
      <svg :class="svgClass" aria-hidden="true">
        <use :xlink:href="iconName"/>
      </svg>
    </template>
    
    <script>
    export default { 
      name: 'SvgIcon',
      props: { 
        iconClass: { 
          type: String,
          required: true
        },
        className: { 
          type: String,
          default: ''
        }
      },
      computed: { 
        iconName() { 
          console.log('#icon-${this.iconClass}', `#icon-${ this.iconClass}`)
          return `#icon-${ this.iconClass}`
        },
        svgClass() { 
          if (this.className) { 
            return 'svg-icon ' + this.className
          } else { 
            return 'svg-icon'
          }
        }
      }
    }
    </script>
    
    <style scoped>
    .svg-icon { 
      width: 1em;
      height: 1em;
      vertical-align: -0.15em;
      fill: currentColor;
      overflow: hidden;
    }
    </style>

##### 2.2.4 主文件引入main.js #####

import './icons'

##### 2.2.5 使用demo.vue #####

<svg-icon icon-class="agent"></svg-icon>

### 三. 坑？？？？ ###

这种方式在使用的时候80%~90%是没问题的，那什么情况下会出现问题呢？首先看vue.config.js里面的配置，我们实现删除了关于svg编译的而配置，然后加载了 `svg-sprite-loader` 这个loader，在这个loader里面我们add了一些受控文件目录，所以如果不在这个目录里面的svg怎么办？肯定会报错，那我们可以多几个add，但是我们引用的一些npm包里面也有用svg的时候编译还是不会通过，那我们不删除svg的配置了，不好意思svg组件不管用，好难啊，最粗鲁的方式就是不使用这些npm包。。。。。有好的方案在更新，临时还没有好的方案。