在 Vue 项目中如何使用 svg？

在 vue 项目中我们可以使用 svg 来导入图标。以后台管理系统为例。

涉及相关文件及目录

• 静态资源文件夹下的 icons/svg 用来存放 svg 图标；
• 静态资源文件夹下的 icons/index.js 用来全局导入组件及实现自动导入所有图标；
• vue.config.js 文件中配置 loader；

使用步骤

1. 安装 svg-sprite-loader

2. 配置 loader 及 svg 图标存放目录

在 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/assets/icons"))
      .end();
    config.module
      .rule("icons")
      .test(/\.svg$/)
      .include.add(resolve("src/assets/icons"))
      .end()
      .use("svg-sprite-loader")
      .loader("svg-sprite-loader")
      .options({
        symbolId: "icon-[name]"
      })
      .end();
  }
};

3. 自动导入所有图标

• 在 icons/index.js 中编写自动导入的逻辑代码；

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

• 在 main.js 中引入；

// main.js
import "./assets/icons/index";

4. 创建使用 svg 图标的公共组件

将使用 svg 图标的代码封装成一个公共的组件。

在 src/components 下创建 SvgIcon 目录

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

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'
      }
    }
  }
}

5. 全局注册组件

在 icons/index.js 中全局注册该组件

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

Vue.component('svg-icon', SvgIcon)

6. 使用 svg 图标

当我们需要使用 svg 图标时，可以导入通用的组件 SvgIcon。

由于组件是全局注册的，因此可以直接使用：

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

icon-class 属性的值为 svg 文件夹下图标文件的名称。