---
title: "VUE 框架導入 SVG & SVG Sprite 實戰筆記"
description: "介紹如何在 Vue 框架中導入 SVG 與 SVG Sprite，透過 svg-sprite-loader 與 svgo 優化圖示載入效能，並實作 SvgIcon 元件。"
canonical_url: "https://blog.markkulab.net/post/svg-and-svg-sprite"
author: "Mark Ku"
author_url: "https://blog.markkulab.net/author/mark-ku"
site: "Mark Ku's Blog"
date_published: "2021-10-16 01:01:01 +0800"
category: "Frontend"
tags: ["vue", "svg", "svg-sprite", "webpack", "frontend", "icon"]
language: "zh-TW"
license: "CC BY 4.0"
license_url: "https://creativecommons.org/licenses/by/4.0/"
attribution: "轉載或引用請註明作者並附上原文連結"
---

# VUE 框架導入 SVG & SVG Sprite 實戰筆記

## 為什麼要導入 SVG & SVG Sprite
* 瀏覽器因圖片縮放比例，圖片會呈現模糊失針問題，產生馬賽克。  
* 一堆小 ICON 載入，每個很小的圖片，卻分開去請求，造成伺服器的壓力，同時減少 request 數量，優關網站存取速度。

## 了解什麼是 SVG 
透過文字編輯器打開 SVG 圖檔 ，我們會發文件裡裡存放圖片的路徑顏色，結構很像Html，是由 TAG 和 Attribute 組成，因此同相的圖樣放大幾倍都不會影響圖片的尺寸大小。
![SVG 原始碼顯示圖形路徑與濾鏡定義](https://blog.markkulab.net/content/markku/posts/svg-and-svg-sprite/images/WSiwJ4v.png)

## 優缺點
### 優點
1. 無失針，向量圖，支援縮放，放大不會鋸齒狀
2. 圖片文字可編輯複製
3. 可透過 css 修改 svg 圖檔顏色

### 缺點
1. 一樣的圖檔，大小稍大。 ( 因此適合用在簡單的 Icon )
2. 舊瀏覽器不支援。 ex : IE 11

## SVG Sprite 在網站的載入方法

### 1.方法一 -  將多張圖拼在同一張，給予不同座標，透過 CSS 位置屬性來顯示。

```
.icon-match-event-3 {
  width: 24px;
  height: 24px;
  zoom: 0.8;
  background-position: -28px -4px;
  background-repeat: no-repeat;
  background-thumbnail: url(~@/assets/images/icon/match-event/match-event.svg);
}
```

### 2.方法二 - 將多張SVG 圖的路徑內容併在同個 SVG 中，並渲染在 HTML 中，並透過 :xlink:href=#targetId 來切換顯示內容。

![SVG Sprite 定義多個圖示的程式碼](https://blog.markkulab.net/content/markku/posts/svg-and-svg-sprite/images/MP38l0l.png)

```
  <svg :class="svgClass" aria-hidden="true">
    <use :xlink:href="`#${svgId}`" />
  </svg>
```

## SVG 在前端開發上特別的特性
### 1.SVG 在入載入時，CSS 的 Display 預設 none，不會顯示，需要額外給 CSS Display，才會顯示在頁面中。[MDN SVG 說明](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/display)
### 2. 在縮放時(Zoom) 會跳脫網頁排版，在瀏覽器除錯時，偵錯工具不會依據縮放的大小來顯示大小。
### 3. SVG 圖檔是可以透過文字檔開啟來編輯，結構如同 html。
### 4.壓縮 svg 大小
1. 一般在繪圖工具所產生的 svg 圖檔，會額外產生用不到的 svg 屬性，這些屬性一多，也會影響圖檔的大小，這邊可以透過 webkapck plugin 移除一些不需要的屬性。  
ex:[vue-svgo-loader](https://github.com/monster1935/vue-svg-icon?fbclid=IwAR13ww3-w6apMINVi9SFmuEW0J6Ud46dcqkbsuQLDaLcwgqPvmmTEfC-kp4)

--------------------------------------------------

## 在 VUE 框架中，簡化載入 SVG
為了像 icon font 一樣使用方便，我們得透過 svg loader 

### 安裝

```
npm install svg-sprite-loader --save-dev
npm install svgo svgo-loader --save-dev
```

### 調整 Vue.config 

```
chainWebpack: (config) => {
    config.module
      .rule('svg')
      .exclude.add(resolve('src/assets/images/svg-icon'))
      .end()

    config.module
      .rule('icons')
      .test(/\.svg$/)
      .include.add(resolve('src/assets/images/svg-icon'))
      .end()
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon-[name]',
        extract: true,
        outputPath: 'static/img/',
        publicPath: 'static/img/',
        spriteFilename: 'main.svg'
      })
      .end()
      .use('svgo-loader') // 最佳化 svg (優化寫法及移除不需要的 attibute , 約可以減少30% 以上的圖檔大小)
      .loader('svgo-loader')
      .end()

    config.plugin('svg-sprite') // extract: true 才需要
      .use(require('svg-sprite-loader/plugin')) 
}
```

### 撰寫 Vue SVGIcon Component 元件
```
<template>
  <svg :class="svgClass" aria-hidden="true">
    <use :xlink:href="`#icon-${iconName}`" />
  </svg>
</template>

<script>

export default {
  name: 'SvgIcon',
  props: {
    iconName: {
      type: String,
      default: '',
      required: false
    }
  },
  data: function() {
    return {

    }
  },
  computed: {
    svgClass() {
      if (this.iconClass) {
        return 'svg-icon ' + 'icon-' + this.iconClass
      } else {
        return 'svg-icon'
      }
    }
  }

}
</script>

<style>
.svg-icon {
  display: inline-block;
  overflow: hidden;
  width: 32px;
  height: 32px;
  fill: currentColor;
}
</style>

```
### 在 App component 元件 中載入 main.svg
```

<template>
  <div>
    <Layout id="app" />
    <span v-if="htmlSvgString.length" v-once id="mainSvg" v-html="htmlSvgString" />
  </div>
</template>

<script>
import Layout from '@/views/layout'
export default {
  components: { Layout },
  data: function() {
    return {
      htmlSvgString: ''
    }
  },
  created() {
    const that = this
    fetch('./static/images/main.svg')
      .then(r => r.text())
      .then(text => {
        that.htmlSvgString = text
      })
  }
}
</script>


<style lang="scss">
#mainSvg {
  position: absolute;
  width: 0;
  height: 0;

  svg {
    position: absolute;
    width: 0;
    height: 0;
  }
}

// 如果要改色，要指定id，原本的顏色會掉，會吃父層的顏色
 #icon-dropdown_b {
   path {
     fill: currentColor;
   }
 }
</style>
```

### 在 vue 全域註冊 ( main.js )

```
import SvgIcon from '@/components/SvgIcon'
Vue.component('Icon', SvgIcon)

// 引入至 web pack 
const requireAll = requireContext => requireContext.keys().map(requireContext)
const req = require.context('@/assets/images/svg-icon', true, /\.svg$/)
requireAll(req)

```

### 將 SVG 圖檔放進 svg-icon

### 頁面使用方式
```
// icon-name 填入 icon 的檔案名稱
<SvgIcon :icon-name="getIconFileName(tab)" class="tab-icon" />
```

## 補充
1. 如果改不動svg 顏色，檢查下層的 path 是不是有顏色，需要改成 currentColor
```
 #icon-dropdown_b {
   path {
     fill: currentColor;
   }
 }
 ```
2. 依據子資料夾去分類打包成一個 SVG Sprite，可以參考這篇 [Generating Multiple Sprites](https://github.com/JetBrains/svg-sprite-loader/issues/320?fbclid=IwAR3XvehC1QER7s4S9F8FGKjjv1dv5d_tfOE6sHWZ9_ElPUeh-5XP2W7NC84)
3. iCon font，只有單色，可以透過[icomoon網站](https://icomoon.io/)上傳 svg 製作。
4. Windows 檔案總管在管理 svg 圖時，無法預覽，裝 svg-explorer-extension 這個可以預覽[下載連結](https://github.com/tibold/svg-explorer-extension/releases)

---

## 關於本文與作者

本文出自 [Mark Ku's Blog](https://blog.markkulab.net/post/svg-and-svg-sprite)

授權條款： [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — 轉載或引用請註明作者並附上原文連結

### 關於作者

**[Mark Ku](https://blog.markkulab.net/author/mark-ku)** — Software Solution Provider

- 10+ 年資深軟體工程師，現為 AI 應用 Builder
- 專注大型平台架構設計，從北美電商到AI SaaS訂閱收費系統
- 結合 AI Agent 與自動化，打造高效可演進的產品技術基礎

### 作者開發的免費工具

以下工具皆可免費使用：

- [免費 PDF 簽名工具](https://blog.markkulab.net/tools/pdf-sign): 線上 PDF 簽名工具，瀏覽器內完成手繪、打字、上傳簽名，可拖曳放置、縮放、下載。所有處理都在你的裝置完成，檔案不會上傳。
- [VS Code Refactory](https://blog.markkulab.net/tools/refactory): Refactory 是一款 VS Code 重構擴充套件：34 個重構動作、37 條 code smell 檢查、Code Health 儀表板、18 種語言、534 支測試。懂你的專案慣例：介面放哪、DI 註冊寫在哪、'use client' 該不該加；還會用 git 修改頻率 × 複雜度排出「該先修哪個檔案」，並一鍵把壞味道交給你自己電腦上的 Claude Code 修。免費使用，原始碼不離開你的機器。
- [DB-Kit 資料庫管理工具](https://blog.markkulab.net/tools/db-kit): DB-Kit 是一個用 Tauri + Rust + React 打造的輕量跨平台資料庫管理工具，用單一一致的介面同時管理 MySQL、MariaDB、PostgreSQL、SQL Server、Oracle、SQLite、MongoDB、Redis、Kafka、Elasticsearch 與 RabbitMQ 十一種資料來源：連線密碼以 OS keychain 加密、SSH Tunnel、完整 CRUD、視覺化查詢建構器、多結果集同時顯示、跨連線資料傳輸與比對同步、Excel / CSV 匯入匯出、執行計畫視覺化、ER 圖、排程備份、SQL 壓力測試（p50～p99 延遲百分位）、15 條規則的 SQL 審查、Kafka 訊息瀏覽與監控告警；繁中 / 英文雙語介面，內建 AI 助手（自然語言生成 SQL、AI 審查與調校建議）與命令列工具 dbk。免費開源（MIT），提供 Windows / macOS / Linux 安裝檔。
- [VS Code Super Mermaid](https://blog.markkulab.net/tools/super-mermaid): Super Mermaid 是一款 VS Code 擴充套件：開箱即用的漂亮 Mermaid 圖表，自動上色、即時預覽、滑鼠平移縮放、PNG / SVG 高解析匯出，內建 21 種範本與多種主題。免費開源（MIT）。
- [React Super Mermaid](https://blog.markkulab.net/tools/react-super-mermaid): react-super-mermaid 是一個開源 React 元件庫：一行 <MermaidViewer> 即可渲染漂亮的 Mermaid 圖表，內建 colorful / sketch 主題、平移縮放、圖內搜尋、SVG / PNG 高解析匯出。輕量、SSR 安全、完整 TypeScript 型別。免費開源（MIT）。
- [Jira / Confluence Super Mermaid](https://blog.markkulab.net/tools/jira-super-mermaid): Atlassian Forge app：在 Jira issue 與 Confluence 內文直接寫 Mermaid 語法，畫流程圖、時序圖、狀態機與甘特圖。11 種圖表、SVG / PNG 匯出、明暗主題、完整中日韓文字支援。取得 Runs on Atlassian 資格：圖表存在你自己的站台，app 不呼叫任何第三方服務。免費，即將上架 Atlassian Marketplace。
- [Mermaid 線上預覽](https://blog.markkulab.net/tools/mermaid-preview): 在瀏覽器裡寫 Mermaid、即時看圖，整張圖表壓進網址就能分享。免註冊、不上傳伺服器，相容 mermaid.live 的分享連結。
- [React Intl Phone Number](https://blog.markkulab.net/tools/react-intl-phone-number): react-intl-phone-number 是一個開源 React 元件：framework-agnostic、不依賴 antd，提供 E.164 進出、可搜尋國旗 / 國碼下拉、可配置驗證等級（strict / mobile-strict / loose）、可主題化 CSS 與 i18n，電話邏輯由 google-libphonenumber 驅動。輕量、完整 TypeScript 型別。免費開源（MIT）。
- [Uptime Kuma Cluster](https://blog.markkulab.net/tools/uptime-kuma-cluster): 把單機版 Uptime Kuma 改造成高可用叢集：OpenResty + Lua 智慧負載平衡、MariaDB 共享狀態、健康檢查與自動 Failover，附叢集管理 REST API，一行 Docker Compose 啟動。免費開源（MIT）。
- [特教專案](https://blog.markkulab.net/education): 為特殊教育學生製作的學習教材

### 每日 Podcast

- [科技新鮮事](https://blog.markkulab.net/category/tech-news): 每日精選 AI 與科技趨勢，透過語音摘要快速掌握最新技術動態，涵蓋 AI 應用、軟體架構、DevOps 與工程實戰。 — RSS: https://blog.markkulab.net/feed.xml
- [AI股市蝦聊](https://blog.markkulab.net/category/ai-stock-chat): 每個交易日用 AI 分析台股盤勢，以雙人對話聊當天的盤中觀察與隔日預測。 — RSS: https://blog.markkulab.net/ai-stock-chat/feed.xml

### 電子報

[訂閱電子報](https://blog.markkulab.net/subscribe) — 第一時間收到新文章通知，無垃圾信、隨時可取消訂閱。