# snowpack-vue-svg-plugin

> A Snowpack plugin to load SVG files as Vue components

Latest version **2.0.0** (published 2021-08-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install snowpack-vue-svg-plugin
pnpm add snowpack-vue-svg-plugin
yarn add snowpack-vue-svg-plugin
bun add snowpack-vue-svg-plugin
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-08-23 |
| First published | 2021-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Maintainers | igloczek |
| Keywords | snowpack, svg, svgo, vue, inline, snowpack-plugin |

## Links

- npm: https://www.npmjs.com/package/snowpack-vue-svg-plugin
- Repository: https://github.com/SnowdogApps/snowpack-vue-svg-plugin
- Homepage: https://github.com/SnowdogApps/snowpack-vue-svg-plugin#readme
- Issues: https://github.com/SnowdogApps/snowpack-vue-svg-plugin/issues
- npm.io page: https://npm.io/package/snowpack-vue-svg-plugin

## Dependencies (2)

- [svgo](https://npm.io/package/svgo.md) ^2.4.0
- [@vue/compiler-sfc](https://npm.io/package/@vue/compiler-sfc.md) ^3.2.4

## Recent versions

- 2.0.0 (latest) — 2021-08-23
- 1.0.0 — 2021-08-12

## README

# snowpack-vue-svg-plugin
A Snowpack plugin to load SVG files as Vue components.

Plugin has built-in [SVGO](https://github.com/svg/svgo) support for SVG optimization.

```
yarn add -D snowpack-vue-svg-plugin
npm install --save-dev snowpack-vue-svg-plugin
```

```js
// snowpack.config.mjs
export default {
  plugins: [
    'snowpack-vue-svg-plugin'
  ]
}
```

## Usage

```vue
// Component.vue
<template>
  <Logo />
</template>

<script>
import Logo from '../assets/logo.svg'

export default {
  components: {
    Logo
  }
}
</script>
```

## Plugin Options

| Name | Type | Description |
| :-| :-: | :- |
| `input` | `array` | File extension to transform (default: `['.svg']`) |
| `svgo` | `boolean` | Toggle SVGO (default: `true`) |
| `svgoConfig` | `object` | [SVGO config](https://github.com/svg/svgo#configuration) (default: `{}`) |

### `input`
If you already have a plugin registered to load `.svg` files and want to keep using it in parallel to this plugin, you should overwrite the default `input` option.

```js
// snowpack.config.mjs
export default {
  plugins: [
    ['snowpack-vue-svg-plugin', {
      input: ['.vue.svg']
    }]
  ]
}
```

### `svgo` and `svgoConfig`

```js
// snowpack.config.mjs
export default {
  plugins: [
    ['snowpack-vue-svg-plugin', {
      svgo: true,
      svgoConfig: {
        multipass: true
      }
    }]
  ]
}
```

---
_Source: https://npm.io/package/snowpack-vue-svg-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
