在vue項目中使用 SVG Sprites

前言

網(wǎng)頁圖標(biāo)展示方式大概可以分為以下幾類

前端工程化 - 工程配置 vue-cli3+

在了解 SVG Sprites 技術(shù)之后歉井,引出本文的主角:svg-sprite-loader 這是關(guān)鍵

1、雛形

vue-cli 內(nèi)置的webpack配置會將svg文件使用 file-loader 進(jìn)行加載哈误,這不符合我們當(dāng)前的需求

  • 解決方案:固定目錄下的svg文件使用 svg-srpite-loader 進(jìn)行加載哩至,其它則繼續(xù)使用 file-loader,目前網(wǎng)上搜索到的解決方案基本如此
// vue.config.js
const path = require('path');
function Resolve(dir) {
  return path.join(__dirname, dir);
}
module.exports = {
  chainWebpack: config => {
    config.module.rule('svg').exclude.add(Resolve('src/assets/icons')); //讓file-loader排除掉這個目錄
    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()
      //使用svgo-loader 進(jìn)行優(yōu)化蜜自,去除svg本身的填充色
      .use('svgo-loader').loader('svgo-loader').options({
        plugins: [
          {removeAttrs: {attrs: 'path:fill'}},
          { removeXMLNS: true }
        ]
      })
  }
}
// main.vue
<template>
  <svg>
    <use :xlink:href="'#'+iconId"></use>
  </svg>
</template>
<script>
  import MySvg '@/assets/icons/logo.svg';  // src/assets/icons/logo.svg
  export default {
    data() {
      return {
        iconId: MySvg.default.id
      }
    }
  }
</script>

這樣做有一個問題菩貌,如果圖標(biāo)是頁面專屬,其它頁面不會用到重荠,把svg都放在同一個目錄下箭阶,沒有跟隨組件目錄,那這樣就非常不好管理。

2仇参、優(yōu)化

vue-cli的官方文檔中看到這么一段話:

2020-11-27_114659.jpg

不再局限于 src/assets/icons 目錄下嘹叫,而是判斷文件名以 .icon.svg 結(jié)尾:

// vue.config.js
const path = require('path');
function Resolve(dir) {
  return path.join(__dirname, dir);
}
module.exports = {
  chainWebpack: config => {
    //svg sprites
    const svgRule = config.module.rule('svg')
    svgRule.uses.clear()
    svgRule.oneOf('icon').test(/\.icon\.svg$/)
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon_[hash:base64:5]',
      }).end()
      .use('svgo-loader').loader('svgo-loader').options({
        plugins: [
          {removeAttrs: {attrs: 'path:fill'}},
          { removeXMLNS: true }
        ]
      }).end()

    //普通svg圖片
    svgRule.oneOf('img').test(/\.svg$/)
      .use('file-loader')
      .loader('file-loader').options({
        name: 'img/[name].[hash:8].[ext]'
      })
  }
}

3、和 import诈乒、require 說再見吧

經(jīng)過上面的優(yōu)化后罩扇,在svg文件引入的方式上還是有些不盡人意,有沒有像 img 標(biāo)簽?zāi)菢邮娣氖褂梅绞侥嘏履ィ慨?dāng)然有暮蹂!首先看看在基于vue-cli腳手架的項目中是怎么實現(xiàn):
處理靜態(tài)資源

2020-11-27_120854.jpg

當(dāng)然,這需要vue-loader處理癌压,詳細(xì)文檔
修改vue-loader后的最終配置:

const path = require('path');
function Resolve(dir) {
  return path.join(__dirname, dir);
}
module.exports = {
  chainWebpack: config => {
    //svg sprites
    const svgRule = config.module.rule('svg')
    svgRule.uses.clear()
    svgRule.oneOf('icon').test(/\.icon\.svg$/)
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon_[hash:base64:5]',
      }).end()
      .use('svgo-loader').loader('svgo-loader').options({
        plugins: [
          {removeAttrs: {attrs: 'path:fill'}},
          { removeXMLNS: true }
        ]
      }).end()

    //普通svg圖片
    svgRule.oneOf('img').test(/\.svg$/)
      .use('file-loader')
      .loader('file-loader').options({
        name: 'img/[name].[hash:8].[ext]'
      })

    //vue-loader
    config.module
    .rule('vue')
    .use('vue-loader')
      .loader('vue-loader')
      .tap(options => {
        // 修改它的選項...
        options.transformAssetUrls = {
          video: ['src', 'poster'],
          source: 'src',
          img: 'src',
          image: ['xlink:href', 'href'],
          use: ['xlink:href', 'href'],
          'vc-svg-icon': 'src'  //這一項是關(guān)鍵仰泻,下面的組件封裝有用到
        }
        return options
      })
  }
}

上面的 options.transformAssetUrls['vc-svg-icon'] = 'src',讓vue-loader識別vc-svg-icon組件的src屬性滩届,并對其解析為一個 模塊依賴

4集侯、組件封裝

<template>
  <svg class="vc-svg-icon" aria-hidden="true" :icon-href="href">
    <use :xlink:href="href"></use>
  </svg>
</template>

<script>
  export default {
    name: 'SvgIcon',
    props: {
      src: module
    },
    computed: {
      href() {
        return `#${this.src.default.id}`
      }
    },
    mounted() {
      //初始化時查找是否存在該 symbol
      const container = document.querySelector('#__SVG_SPRITE_NODE__')
      if (!container.querySelector(this.href)) {
        container.insertAdjacentHTML('beforeend', this.src.default.content)
      }
    },
    destroyed() {
      //組件銷毀后查找是否存在無用的 symbol,沒有被vc-svg-icon組件引用則移除對應(yīng)的symbol
      const hasIcon = document.querySelector(`[icon-href="${this.href}"]`)
      const symbol = document.querySelector('#__SVG_SPRITE_NODE__').querySelector(this.href)
      if (!hasIcon && symbol) {
        symbol.remove()
      }
    }
  }
</script>
<style>
  .vc-svg-icon {
    width: 1em;
    height: 1em;
    vertical-align: middle;
    fill: currentColor;
    overflow: hidden;
  }
</style>

mounteddestroyed 生命周期里的處理是為了“用完即銷毀”帜消,可自行斟酌棠枉,非必要,因為symbol標(biāo)簽的父級svg#__SVG_SPRITE_NODE__是隱藏的(display:none)泡挺,大量存在無用的symbol標(biāo)簽也不會造成性能問題

5辈讶、使用

//*.vue
<template>
<div>
  <!-- 一般使用 -->
   <vc-svg-icon src="./***/***.icon.svg"></vc-svg-icon>
  <!-- src 值在 data 中 -->
  <vc-svg-icon :src="myIcon"></vc-svg-icon>
</div>
</template>
<script>
  export default {
    data() {
      return {
        myIcon: require('./***/***.icon.svg')
      }
    }
  }
</script>
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市娄猫,隨后出現(xiàn)的幾起案子贱除,更是在濱河造成了極大的恐慌,老刑警劉巖媳溺,帶你破解...
    沈念sama閱讀 211,123評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件月幌,死亡現(xiàn)場離奇詭異,居然都是意外死亡悬蔽,警方通過查閱死者的電腦和手機扯躺,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2 384
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蝎困,“玉大人录语,你說我怎么就攤上這事『坛耍” “怎么了澎埠?”我有些...
    開封第一講書人閱讀 156,723評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長盖袭。 經(jīng)常有香客問我失暂,道長彼宠,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,357評論 1 283
  • 正文 為了忘掉前任弟塞,我火速辦了婚禮凭峡,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘决记。我一直安慰自己摧冀,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,412評論 5 384
  • 文/花漫 我一把揭開白布系宫。 她就那樣靜靜地躺著索昂,像睡著了一般。 火紅的嫁衣襯著肌膚如雪扩借。 梳的紋絲不亂的頭發(fā)上椒惨,一...
    開封第一講書人閱讀 49,760評論 1 289
  • 那天,我揣著相機與錄音潮罪,去河邊找鬼康谆。 笑死,一個胖子當(dāng)著我的面吹牛嫉到,可吹牛的內(nèi)容都是我干的沃暗。 我是一名探鬼主播,決...
    沈念sama閱讀 38,904評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼何恶,長吁一口氣:“原來是場噩夢啊……” “哼孽锥!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起细层,我...
    開封第一講書人閱讀 37,672評論 0 266
  • 序言:老撾萬榮一對情侶失蹤惜辑,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后今艺,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體韵丑,經(jīng)...
    沈念sama閱讀 44,118評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2 325
  • 正文 我和宋清朗相戀三年虚缎,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片钓株。...
    茶點故事閱讀 38,599評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡实牡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出轴合,到底是詐尸還是另有隱情创坞,我是刑警寧澤,帶...
    沈念sama閱讀 34,264評論 4 328
  • 正文 年R本政府宣布受葛,位于F島的核電站题涨,受9級特大地震影響偎谁,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜纲堵,卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3 312
  • 文/蒙蒙 一巡雨、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧席函,春花似錦铐望、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至营曼,卻和暖如春乒验,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蒂阱。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1 264
  • 我被黑心中介騙來泰國打工锻全, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蒜危。 一個月前我還...
    沈念sama閱讀 46,286評論 2 360
  • 正文 我出身青樓虱痕,卻偏偏與公主長得像,于是被迫代替她去往敵國和親辐赞。 傳聞我的和親對象是個殘疾皇子部翘,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,465評論 2 348

推薦閱讀更多精彩內(nèi)容