在vue項目中使用svg

首先，為什么要選擇svg，理由是

1.兼容性，現在svg的基本兼容性已經很好了。在canIuse中可以查看。

2.相比較傳統的圖片，svg在放大的時候不會失真

3.因為svg是xml形式的，利於瀏覽器seo搜索，所以一般logo強烈建議用svg

4.可以修改顏色和寬高（fill,width,height)

5.性能，性能是前端很重要的一個指標，svg相比iconfont圖標整體加載性能要好，svg sprites與png sprites相比性能也不差。

6.如果使用png的雪碧圖，在新增圖標的時候需要修改雪碧圖，並且修改之后可能因為瀏覽的緩存問題導致圖片加載不出。svg不存在這個問題。

所以我們有充足的理由選擇在項目中使用svg

常見的使用svg的方式有：lnline svg, img svg, background svg

inline svg 是直接將svg寫在html的文件中

img svg 是用img標簽引入svg

background svg 是在css,background屬性中設置svg文件

那么如何在vue項目中優雅的使用svg呢

當然，我們可以將svg直接寫在template中，但是這並不優雅，所有現在我們要用到 svg-sprite-loader這個插件

1

pm install svg-sprite-loader --save-dev

2.配置webpack,以vue-cli3的配置為例，在vue.config.js中進行配置

const path = require('path')
chainWebpack: config => {
    config.module
      .rule('svg')
      .uses.clear()
    config.module
      .rule('svg1')
      .test(/\.svg$/)
      .use('svg-sprite')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon-[name]'
      })
      .end()
      .include
      .add(path.join(__dirname,'src/icons'))
      .end()
  }

3.在src下新建icons文件夾，目錄結構是這樣的

index.js 中的代碼是這樣的

import Vue from 'vue'
import SvgIcon from '@/components/SvgIcon' // svg組件

// register globally
Vue.component('svg-icon', SvgIcon)

const requireAll = requireContext => requireContext.keys().map(requireContext)
const req = require.context('./svg', false, /\.svg$/)
requireAll(req)

全局注冊了svg-icon組件

4.SvgIcon中的代碼是這樣的

<template>
  <svg :class="svgClass" aria-hidden="true" v-on="$listeners">
    <use :xlink:href="iconName"/>
  </svg>
</template>

<script>
export default {
  name: 'SvgIcon',
  props: {
    iconClass: {
      type: String,
      required: true
    },
    className: {
      type: String,
      default: ''
    }
  },
  computed: {
    iconName () {
      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>

5.在入口文件main.js中引入

6.到此我們的組件和配置都已經完成了，可以愉快的使用了

到此就完成了vue中使用svg的功能了。現在我們再來關注下index.js中require.context的使用。為什么要用這個api呢？一般情況下，我們單個import，也是可以實現效果的，但是像這種情況，文件夾下有多個svg文件，如果單個import，就會很繁瑣，而且以后增加了svg文件，都需要修改index.js，針對這種場景，就需要用到context，此方法接受三個參數，文件路徑，是否引入文件的子目錄，正則匹配文件，如

const req = require.context('./svg', false, /\.svg$/)

這行代碼的意思是，加載svg文件夾下所有.svg結尾的文件，那么返回的req是什么呢？打印出來看

 

可以看到返回的是一個方法，方法有三個屬性，id, keys, resolve 

id,不做研究了，應該很少用到

keys方法返回什么呢？執行

req.keys()

返回結果：

然后吧key作為參數傳遞給req這個方法（req是個方法哦）

let svgs = []
req.keys().forEach(key => {
  let file = req(key)
  svgs = svgs.concat(file)
});
console.log(svgs)

打印出來的svgs是

 

和requireAll的執行結果是一樣的。所以如果上面的const requireAll = requireContext => requireContext.keys().map(requireContext)看不明白的話也可以這樣寫（index.js)

import Vue from 'vue'
import SvgIcon from '@/components/SvgIcon' // svg組件

// register globally
Vue.component('svg-icon', SvgIcon)

// const requireAll = requireContext => requireContext.keys().map(requireContext)
const req = require.context('./svg', false, /\.svg$/)
let svgs = []
req.keys().forEach(key => {
  let file = req(key)
  svgs = svgs.concat(file)
});
// requireAll(req)

綜上，context這個api是用於集中import文件，是不是方便了許多，趕快用起來吧。