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

Fork by vite-svg-loader

Install:

npm add rsbuild-plugin-svg -D

Add plugin to your rsbuild.config.ts:

// rsbuild.config.ts
import { pluginSvg } from "rsbuild-plugin-svg";

export default {
  plugins: [pluginSvg()],
};

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

import iconUrl from './my-icon.svg?url'
// 'data:image/svg+xml...'

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

import iconRaw from './my-icon.svg?raw'
// '<?xml version="1.0"?>...'

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

import IconComponent from './my-icon.svg?component'
// <IconComponent />

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.

svgLoader({
  defaultImport: 'url' // or 'raw' default: 'component'
})

svgLoader({
  svgoConfig: {
    multipass: true
  }
})

svgLoader({
  svgo: false
})

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

import IconWithoutOptimizer from './my-icon.svg?skipsvgo'
// <IconWithoutOptimizer />

If you use the loader in a Typescript project, you'll need to reference the type definitions inside vite-env.d.ts:

/// <reference types="vite/client" />
/// <reference types="vite-svg-loader" />

MIT.