如何在vue專案中優雅的使用SVG

SilentLove發表於2018-12-03

1、基礎介紹

  • 本文旨在介紹如何在專案中配置和方便的使用svg圖示。
  • 本文以vue專案為例,當然在react中的使用原理基本相似。
  • svg圖示可以直接通過img標籤來使用,也可當做icon來使用。
  • 本文是參考了鑫旭大佬的文章:SVG Sprite技術介紹
  • 程式碼已上傳github:github地址

2、配置

  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]')
    }
}
複製程式碼
  1. 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]')
    }
  }
複製程式碼

3、使用

  1. 在components下建立svg資料夾,建立Svg.vue檔案:
  <svg :class="svgClass" aria-hidden="true">
    <use :xlink:href="iconName"></use>
  </svg>
複製程式碼
  1. 在utils資料夾下建立svgConfig資料夾,建立index.js檔案,全域性註冊svg-icon元件。
Vue.component('svg-icon', SvgIcon)
複製程式碼
  1. 使用require.context自動匯入檔案,而不需要import一個個去引用:
const requireAll = requireContext => requireContext.keys().map(requireContext)
const req = require.context('./../../../static/svg/', true, /\.svg$/)
requireAll(req)
複製程式碼

如何在vue專案中優雅的使用SVG
4. 在main.js在執行:

import '@/utils/svgConfig'
複製程式碼

到此我們就可以直接在專案中使用:

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

4、優化

  • 雖然現在已經可以使用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>
複製程式碼
  1. 獲取iconsMap,在utils資料夾下建立svgConfig資料夾,generateIconsView.js檔案, 當然如果你使用了vuex,也可以儲存在vuex中的state中:
const data = {
  state: {
    iconsMap: []
  },
  generate (iconsMap) {
    this.state.iconsMap = iconsMap
  }
}

export default data
複製程式碼
  1. 將資料儲存在iconsMap中:
    如何在vue專案中優雅的使用SVG
  2. 在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>
複製程式碼
  1. 新增點選複製的提示和方法(cnpm i -S clipboard),在SvgList.vue中使用:
 methods: {
    generateIconCode (symbol) {
      return `<svg-icon icon-class="${symbol}" />`
    },
    handleClipboard (text, event) {
      clipboard(text, event)
    }
}
複製程式碼
  1. 在路由新增SvgList.vue的路由資訊,頁面效果如下:
    如何在vue專案中優雅的使用SVG

相關文章