Vue Inline SVG

Vue component loads an SVG source dynamically and inline <svg> so you can manipulate the style of it with CSS or JS. It looks like basic <img> so you markup will not be bloated with SVG content. Loaded SVGs are cached so it will not make network request twice.

Using Vue v2?

Check old version vue-inline-svg@2

• Install
  • NPM
  • CDN
• Usage
  • props
  • src
  • title
  • keepDuringLoading
  • transformSource
  • SVG attributes
  • events
  • loaded
  • unloaded
  • error
• Comparison
• Changelog
• Contributing
• License

Install

NPM

npm install vue-inline-svg

Register locally in your component

import InlineSvg from 'vue-inline-svg';

// Your component
export default {
    components: {
        InlineSvg,
    }
}

Or register globally in the Vue app

import { createApp } from 'vue'
import InlineSvg from 'vue-inline-svg';

const app = createApp({/*...*/});
app.component('inline-svg', InlineSvg);

CDN

<script src="https://unpkg.com/vue"></script>
<!-- Include the `vue-inline-svg` script on your page after Vue script -->
<script src="https://unpkg.com/vue-inline-svg"></script>

<script>
const app = Vue.createApp({/*...*/});
app.component('inline-svg', VueInlineSvg);
</script>

Usage

<inline-svg
    src="https://github.com/shrpne/vue-inline-svg/raw/master/image.svg"
    transformSource="transformSvg"
    @loaded="svgLoaded($event)"
    @unloaded="svgUnloaded()"
    @error="svgLoadError($event)"
    width="150"
    height="150"
    fill="black"
    aria-label="My image"
></inline-svg>

Example

props

- src

Path to SVG file

<inline-svg src="https://github.com/shrpne/vue-inline-svg/raw/master/my.svg"/>

Note: if you use vue-loader assets or vue-cli, then paths like '../assets/my.svg' will not be handled by file-loader automatically like vue-cli do for <img> tag, so you will need to use it with require:

<inline-svg :src="https://github.com/shrpne/vue-inline-svg/raw/master/require('../assets/my.svg')"/>

Learn more:

• https://vue-loader.vuejs.org/guide/asset-url.html#transform-rules
• https://cli.vuejs.org/guide/html-and-static-assets.html#static-assets-handling

- title

Sets/overwrites the <title> of the SVG

<inline-svg :src="https://github.com/shrpne/vue-inline-svg/raw/master/image.svg" title="My Image"/>

- keepDuringLoading

true by default. It makes vue-inline-svg to preserve old image visible, when new image is being loaded. Pass false to disable it and show nothing during loading.

<inline-svg :src="https://github.com/shrpne/vue-inline-svg/raw/master/image.svg" :keepDuringLoading="false"/>

- transformSource

Function to transform SVG source

This example create circle in svg:

<inline-svg :src="https://github.com/shrpne/vue-inline-svg/raw/master/image.svg" :transformSource="transform"/>

<script>
const transform = (svg) => {
    let point = document.createElementNS("http://www.w3.org/2000/svg", 'circle');
        point.setAttributeNS(null, 'cx', '20');
        point.setAttributeNS(null, 'cy', '20');
        point.setAttributeNS(null, 'r', '10');
        point.setAttributeNS(null, 'fill', 'red');
        svg.appendChild(point);
    return svg;
}
// For cleaner syntax you could use https://github.com/svgdotjs/svg.js
</script>

SVG attributes

Other SVG and HTML attributes will be passed to inlined <svg>. Except attributes with false or null value.

<!-- input -->
<inline-svg
    fill-opacity="0.25"
    :stroke-opacity="myStrokeOpacity"
    :color="false"
></inline-svg>

<!-- output -->
<svg fill-opacity="0.25" stroke-opacity="0.5"></svg>

events

- loaded

Called when SVG image is loaded and inlined. Inlined SVG element passed as argument into the listener’s callback function.

<inline-svg @loaded="myInlinedSvg = $event"/>

- unloaded

Called when src prop was changed and another SVG start loading.

<inline-svg @unloaded="handleUnloaded()"/>

- error

Called when SVG failed to load. Error object passed as argument into the listener’s callback function.

<inline-svg @error="log($event)"/>

Comparison

• This module:
• vue-simple-svg: , does not cache network requests, has wrapper around svg, attrs passed to <svg> are limited, converts <style> tag into style="" attr
• svg-loader uses different approach, it inlines SVG during compilation. It has pros that SVG is prerendered and no http request needed. But also it has cons that markup size grows, especially if you have same image repeated several times. (Discussed in #11)

Changelog

CHANGELOG.md

Contributing

CONTRIBUTING.md

License

MIT License