svg-patcher v0.3.0

svg-patcher

When you are using several similar SVG files in the same project, you should edit them using JavaScript instead of downloading many slightly different versions of the same image. This library attempts to make this easy.

Try the example

Just start example/example.html in your browser.

If you use Chrome you need to start it with the flag --allow-file-access-from-files. Don't worry, your users won't have to do that. This is only needed when loading files from the file system.

How to use

Simply include svg-patcher.js in your project. It will export svgPatcher in the global scope.

svgPatcher.fetch(url)

• url: String

This function returns a Promise that resolves with a SVG Document.

svgPatcher.fetch('https://getkey.eu/magnifying_glass_icon.svg').then(svgDocument => {
	console.log(svgDocument);
});

svgPatcher.patch(svgDocument, patcher, clonable)

• svgDocument: Document
• patcher: Function
• clonable: Boolean

patcher takes the SVG Document you pass to svgPatcher.patch() as an argument.

svgPatcher.patch() returns a Promise that resolves with a patched Image.

function patcher(svgDocument) {
	// navigate and modify the SVG's DOM however you want
	svgDocument.children[0].setAttribute('fill', 'yellow');
}

svgPatcher.patch(svgDocument, patcher).then(img => {
	document.body.appendChild(img);
});

If clonable is unset or set to false, the resolved image will not be clonable, ie:

let newImg = oldImg.cloneNode(true); // won't work

let newImg = new Image(); // won't
newImg.src = oldImg.src; // work

If you set clonable to true, once you are done cloning it, you should release memory by calling svgPatcher.revoke().

svgPatcher.revoke(img)

• img: Image

Releases the memory used to load your Image. Use this function only if you no longer need to clone your image.

It is only useful to use this function on clonable images.

You can use this function on the original Image or any of its clones.