如何在vue項目中優雅的使用SVG

一、基礎介紹

• 本文旨在介紹如何在項目中配置和方便的使用svg圖標。
• 本文以vue項目爲例，固然在react中的使用原理基本類似。
• svg圖標能夠直接經過img標籤來使用，也可當作icon來使用。
• 本文是參考了鑫旭大佬的文章：SVG Sprite技術介紹。
• 代碼已上傳github：github地址。

二、配置

1. 安裝svg-sprite-loader。經過vue-cli腳手架建立的項目默認狀況下會使用 url-loader 對svg進行處理，因此須要處理下：

{
    test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
    loader: 'url-loader',
    options: {
      limit: 10000,                                      
      name: utils.assetsPath('img/[name].[hash:7].[ext]')
    }
}
複製代碼

2. cnpm i -D svg-sprite-loader。在static下新建svg文件夾，用來放置當作icon使用的svg，使用include,include和img作區分。而後修改webpack.base.conf.js配置,這樣svg-sprite-loader只會處理咱們指定的static/svg下的文件：

{
    test: /\.svg$/,
    loader: 'svg-sprite-loader',
    include: [resolve('static/svg')], // include => 只處理指定的文件夾下的文件
    options: {
        symbolId: 'icon-[name]'
    }
  },
  {
    test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
    loader: 'url-loader',
    exclude: [resolve('static/svg')], // exclude => 不處理指定的文件夾下的文件
    options: {
      limit: 10000,
      name: utils.assetsPath('img/[name].[hash:7].[ext]')
    }
  }
複製代碼

三、使用

1. 在components下建立svg文件夾，建立Svg.vue文件:

<svg :class="svgClass" aria-hidden="true">
    <use :xlink:href="iconName"></use>
  </svg>
複製代碼

2. 在utils文件夾下建立svgConfig文件夾，建立index.js文件，全局註冊svg-icon組件。

Vue.component('svg-icon', SvgIcon)
複製代碼

3. 使用require.context自動導入文件，而不須要import一個個去引用:

const requireAll = requireContext => requireContext.keys().map(requireContext)
const req = require.context('./../../../static/svg/', true, /\.svg$/)
requireAll(req)
複製代碼

4. 在main.js在執行：

import '@/utils/svgConfig'
複製代碼

到此咱們就能夠直接在項目中使用：

<svg-icon icon-class="users" />
複製代碼

四、優化

• 雖然如今已經可使用svg-icon,當是還沒法直觀的分辨svg，當svg文件比較多的時候，若是隻能一個個的去查找將費時費力。爲方便咱們查找和使用svg，能夠新建一個svg的列表頁。

1. 在pages文件下新建SvgList.vue文件，iconsMap爲導入的svg文件數組，handleClipboard方法爲點擊複製的方法，經過安裝clipboard實現（cnpm i -S clipboard）：

<div class="icons-wrapper">
  <div v-for="item in iconsMap" :key="item" @click="handleClipboard(generateIconCode(item), $event)">
    <el-tooltip placement="top">
      <div slot="content">
        {{generateIconCode(item)}}
      </div>
      <div class="icon-item">
        <div>
          <span class="svg-wrap" @click.stop>
            <svg-icon :icon-class="item" />
          </span>
        </div>
        <span>{{item}}</span>
      </div>
    </el-tooltip>
  </div>
</div>
複製代碼

2. 獲取iconsMap，在utils文件夾下建立svgConfig文件夾，generateIconsView.js文件， 固然若是你使用了vuex，也能夠保存在vuex中的state中：

const data = {
  state: {
    iconsMap: []
  },
  generate (iconsMap) {
    this.state.iconsMap = iconsMap
  }
}

export default data
複製代碼

3. 將數據保存在iconsMap中：

   

4. 在SvgList.vue中使用：

<script>
import icons from '@/utils/svgConfig/generateIconsView'
export default {
  name: 'icons',
  data () {
    return {
      iconsMap: []
    }
  },
  mounted () {
    const iconsMap = icons.state.iconsMap.map((i) => {
      return i.default.id.split('-')[1]
    })
    this.iconsMap = iconsMap
  }
}
</script>
複製代碼

5. 添加點擊複製的提示和方法（cnpm i -S clipboard），在SvgList.vue中使用：

methods: {
    generateIconCode (symbol) {
      return `<svg-icon icon-class="${symbol}" />`
    },
    handleClipboard (text, event) {
      clipboard(text, event)
    }
}
複製代碼

6. 在路由添加SvgList.vue的路由信息，頁面效果以下：