vite-svg-react-loader

Vite plugin to import SVG files directly as ReactComponent

Installation

npm

$ npm i --save-dev @andylacko/vite-svg-react-loader

yarn

$ yarn add -D @andylacko/vite-svg-react-loader

Usage

Add svgLoader() (or whatever you decide to name your default import) to the list of plugins in the ViteJS configuration file (vite.config.js) of your project.

import svgLoader from '@andylacko/vite-svg-react-loader'

export default defineConfig({
    //...
    plugins: [svgLoader()]
});

Once you have done that, you can import any of your SVG asset as a React component:

// The default behavior of ViteJS will get you the URL of the asset
import SVGAsset from 'assets/yourMama.svg'

// That you can use normally
function SomeComponent() {
    return (
        <button>
            <SVGAsset /> Click Me!
        </button>
    );
}

Typescript

If you are using this plugin in a Typescript project, adding the type definitions to your tsconfig.json will assign correct types to the imported SVG assets:

{
    "compilerOptions": {
        "types": [ "@andylacko/vite-svg-react-loader/svgType" ]
    }
}

Configuration

`keepEmittedAssets`

By default, the plugin will prevent transformed SVG assets to be emitted when building the production bundle (when using Vite 2.5.0 or later). If you want or need to have those files emitted anyway, pass the {keepEmittedAssets: true} option:

export default defineConfig({
    //...
    plugins: [svgr({ keepEmittedAssets: true })]
});

`svgrOptions`

Allows to pass global svgr configuration flags. See svgr configuration documentation for more details.

export default defineConfig({
    //...
    plugins: [
        svgr({
            svgrOptions: {
                icon: true,
                dimensions: false
                // etc...
            }
        })
    ]
});

// for quick overview
interface SVGROptions {
  icon?: boolean
  dimensions?: boolean
  expandProps?: 'start' | 'end' | false
  svgo?: boolean
  ref?: boolean
  memo?: boolean
  replaceAttrValues?: Record<string, string>
  svgProps?: Record<string, string>
  titleProp?: boolean
}

Acknowledgement

This plugin started as a fork of @honkhonk/vite-plugin-svgr, but it can import svg into react component directly.

License

MIT

xavier-villelegier / vite-svg-react-loader