rollup-plugin-svg-import/README.md

Import SVG images in javascript file

# rollup-plugin-svg-import

Import `.svg` images in javascript files

## Installation

```sh
npm install --save-dev rollup-plugin-svg-import
```

## Usage

By default SVG import returns a `<svg>` DOM node:

```js
import icon from './icon.svg';

document.body.appendChild(icon());
```

To import SVG image as a string, e.g. for SSR, set `stringify` to `true`:

```js
import icon from './icon.svg';

document.body.innerHTML += icon;
```

## Configuration

```javascript
// rollup.config.js
import svg from 'rollup-plugin-svg-import';

export default {
  input: './input.js',
  output: {
    file: './output.js',
    format: 'esm',
  },
  plugins: [
    svg({
     /**
      * If `true`, instructs the plugin to import an SVG as string.
      * For example, for Server Side Rendering.
      * Otherwise, the plugin imports SVG as DOM node.
      */
      stringify: true
    }),
  ],
};
```