开发一个可以全局使用的svg组件

现在项目中的图标基本上都会使用svg,那么如何在项目中优雅地使用svg呢?下面的方式可以参考.

首先是封装一个svg的组件 svgIcon.vue

<template>
  <div v-if="isExternal"
       :style="styleExternalIcon"
       class="svg-external-icon svg-icon"
       v-on="$listeners" />
  <svg v-else
       :class="svgClass"
       aria-hidden="true"
       v-on="$listeners">
    <use :xlink:href="iconName" />
  </svg>
</template>

<script>
// doc: https://panjiachen.github.io/vue-element-admin-site/feature/component/svg-icon.html#usage
import { isExternal } from '@/utils/validate'

export default {
  name: 'SvgIcon',
  props: {
    iconClass: {
      type: String,
      required: true
    },
    className: {
      type: String,
      default: ''
    }
  },
  computed: {
    isExternal () {
      return isExternal(this.iconClass)
    },
    //这里之所以加上icon前缀,是因为在vue.config.js中做了相关配置
    iconName () {
      return `#icon-${this.iconClass}`
    },
    svgClass () {
      if (this.className) {
        return 'svg-icon ' + this.className
      } else {
        return 'svg-icon'
      }
    },
    styleExternalIcon () {
      return {
        mask: `url(${this.iconClass}) no-repeat 50% 50%`,
        '-webkit-mask': `url(${this.iconClass}) no-repeat 50% 50%`
      }
    }
  }
}
</script>

<style scoped>
.svg-icon {
  width: 1em;
  height: 1em;
  vertical-align: -0.15em;
  fill: currentColor;
  overflow: hidden;
}

.svg-external-icon {
  background-color: currentColor;
  mask-size: cover !important;
  display: inline-block;
}
</style>

///utils/validate
/**
 * @param {string} path
 * @returns {Boolean}
 */
export function isExternal (path) {
  return /^(https?:|mailto:|tel:)/.test(path)
}

2.然后新建icons文件夹,新建icons/svg文件夹,将svg文件都放在svg文件夹下,新建icons/index.js文件,在其中注册svgIcon全局组件,并加载svg文件夹中的svg文件.代码如下:

import Vue from 'vue'
import svgIcon from '@/components/svgIcon'// svg component

// register globally
Vue.component('svg-icon', svgIcon)
// 加载svg图标文件
const req = require.context('./svg', false, /\.svg$/)
const requireAll = requireContext => requireContext.keys().map(requireContext)
requireAll(req)

3.到这里还不算结束,还需在vue-config.js中添加打包解析svg的配置

//不处理src/icons之外的svg图片
config.module.rule('svg').exclude.add(resolve('src/icons')).end()
config.module
  .rule('icons')
  .test(/\.svg$/)
  .include.add(resolve('src/icons'))
  .end()
  .use('svg-sprite-loader')
  .loader('svg-sprite-loader')
  .options({
    symbolId: 'icon-[name]'//在这里添加打包后的前缀icon
  })
  .end()

4.现在就可以在项目中任何地方使用svgIcon组件了, 只要你把想使用的图标放在src/icon中, 然后像下面这样使用:

 <svg-icon iconClass="icon_right"></svg-icon>