svg-convert
v1.0.0
Published
SVG Convert is a jQuery plugin that takes an .svg image (<img>) and converts it in to raw SVG code (<svg>)
Downloads
192
Readme
SVG Convert
This plugin was previously called 'Shape SVG Convert'. When updating please note the plugin name and options have changed slightly.
SVG Convert is a jQuery plugin that takes an .svg
image (<img>
) and converts it in to raw SVG code (<svg>
)
It is useful when dealing with Content Management Systems (CMS) where users upload .svg
files. It allows you to then interact with the raw code, changing fills, strokes etc within the sites CSS.
Usage
Important: SVG's can only be converted when ran on a server environment. "Cross Origin Requests" fail on local environments.
Getting Started
Install
The simplest way to get up and running is to copy the svgConvert.min.js
file from dist
and place it in to your js
folder inside your project.
Insert the code below before your </body>
tag.
<script src="js/svgConvert.min.js"></script>
To initialise the plugin, use the code below in your JS files.
$('.svg-convert').svgConvert();
The SVG Convert class .svg-convert
needs to just be added to .svg's that you want converting from images, to raw code.
<img src="images/monkey.svg" class="svg-convert">
This will then convert the image. Any attributes (E.g. class, id, data- etc) you add to the image will be carried across after it has been converted (See Options
below for more information)
Options
General
##Roadmap
- Ability to set options on images with a
data
attribute.