Vite 中文文档

Vite SVG loader


Vite plugin to load SVG files as Vue components, using SVGO for optimization.

  1. ``` vue
  2. <template>
  3.   <MyIcon />
  4. </template>

  6. <script setup>
  7. import MyIcon from './my-icon.svg'
  8. </script>
  9. ```

Install


  1. ``` shell
  2. npm install vite-svg-loader --save-dev
  3. ```

Setup


vite.config.js


  1. ``` js
  2. import svgLoader from 'vite-svg-loader'

  4. export default defineConfig({
  5.   plugins: [vue(), svgLoader()]
  6. })
  7. ```

Import params


URL


SVGs can be imported as URLs using the ?url suffix:

  1. ``` js
  2. import iconUrl from './my-icon.svg?url'
  3. // '/assets/my-icon.2d8efhg.svg'
  4. ```

Raw


SVGs can be imported as strings using the ?raw suffix:

  1. ``` js
  2. import iconRaw from './my-icon.svg?raw'
  3. // '...'
  4. ```

Component


SVGs can be explicitly imported as Vue components using the ?component suffix:

  1. ``` js
  2. import IconComponent from './my-icon.svg?component'
  3. //
  4. ```

Default import config


When no explicit params are provided SVGs will be imported as Vue components by default. This can be changed using the defaultImport config setting, such that SVGs without params will be imported as URLs (or raw strings) instead.

vite.config.js


  1. ``` js
  2. svgLoader({
  3.   defaultImport: 'url' // or 'raw'
  4. })
  5. ```

SVGO Configuration


vite.config.js


  1. ``` js
  2. svgLoader({
  3.   svgoConfig: {
  4.     multipass: true
  5.   }
  6. })
  7. ```

Disable SVGO


vite.config.js


  1. ``` js
  2. svgLoader({
  3.   svgo: false
  4. })
  5. ```

Skip SVGO for a single file


SVGO can be explicitly disabled for one file by adding the ?skipsvgo suffix:

  1. ``` js
  2. import IconWithoutOptimizer from './my-icon.svg?skipsvgo'
  3. //
  4. ```

Use with TypeScript


If you use the loader in a Typescript project, you'll need to import your svg files with the ?component param: import MyIcon from './my-icon.svg?component'.

You'll also need to reference the type definitions:

  1. ``` ts
  2. ///
  3. ```

Sponsors


Thanks to Nexxtmove for sponsoring the development of this project.Your logo or name here? Sponsor this project.