理解svg-icon的工作原理

目标

使用svg-icon

要点 svg-icon是一个全局组件，在src/icons/index.js中定义并注册成立全局组件

在main.js中引入

它额外需要svg-sprite-loader@4.1.3的配合，及对应的vue.config.js中的配置

它的使用格式 。这里的文件名就是在src/icons/svg下的文件名

步骤 1.安装依赖npm i svg-sprite-loader@4.1.3

2.配置 vue.config.js

const path = require('path')
function resolve (dir) {
  return path.join(__dirname, dir)
}
module.exports = {
  chainWebpack (config) {
    // set svg-sprite-loader
    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]'
      })
      .end()
  }
}

3.复制/创建文件

(1) src/icons

src/icons
-       /svg       # 保存图标
-       /index.js  # 注册全局组件

 index.js中写入

import Vue from 'vue'
import SvgIcon from '@/components/SvgIcon'// svg component
 
// register globally
Vue.component('svg-icon', SvgIcon)
 
const req = require.context('./svg', false, /\.svg$/)
const requireAll = requireContext => requireContext.keys().map(requireContext)
requireAll(req)

svg中保存svg图标文件

(2) 组件

componets/SvgIcon/index.vue

 在componets/SvgIcon/index.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)
    },
    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>

（3）validate.js

utils/validate.js

在utils/validate.js 写入

/**
 * Created by PanJiaChen on 16/11/18.
 */
 
/**
 * @param {string} path
 * @returns {Boolean}
 */
export function isExternal (path) {
  return /^(https?:|mailto:|tel:)/.test(path)
}
 
/**
 * @param {string} str
 * @returns {Boolean}
 */
// 手机号校验
export function validUsername (str) {
  // const valid_map = ['admin', 'editor']
  // return valid_map.indexOf(str.trim()) >= 0
  return /^(0|86|17951)?(13[0-9]|15[012356789]|166|17[3678]|18[0-9]|14[57])[0-9]{8}$/.test(str)
}

4.在main.js中引入

import '@/icons'

5.使用

使用格式 。这里的文件名就是在src/icons/svg下的文件名

关于svg-icon可能显示不出来的问题解决

1 可能是由于版本过高 下载指定版本重启服务器就好了

2 可能是由于webpack 配置有问题 导致vuo.config.js失效 可重新配置一下 然后重启服务器

其余的问题欢迎大家一起讨论解决

展示一下成果