flex-svg
v3.0.0-2
Published
Create SVG files of flexible width and height
Downloads
46
Maintainers
Readme
flex-svg
A Node.js module to create SVG files of flexible width and height
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<svg xmlns="http://www.w3.org/2000/svg" width="50px" height="50px">
<rect width="50px" height="50px"/>
</svg>↓
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<svg xmlns="http://www.w3.org/2000/svg">
<rect width="50px" height="50px"/>
</svg>If width and height attributes of outermost svg elements are not specified, they are regarded as 100% according to SVG 1.1 Specification.
Used by
- grunt-flex-svg (Grunt plugin)
- gulp-flex-svg (gulp plugin)
Installation
npm install flex-svgAPI
const flexSvg = require('flex-svg');flexSvg(SVGdata [, options], callback)
SVGdata: string Buffer (SVG)
options: Object (directly passed to the xml2js.Parser options and the xml2js.Builder options)
callback: Function
callback(error, result)
error: Error if it fails to parse SVG, otherwise null
result: String of SVG without width and height attributes
const fs = require('fs');
const flexSvg = require('flex-svg');
fs.readFile('path/to/file.svg', (readErr, data) => {
if (readErr) {
throw readErr;
}
flexSvg(data, (parseErr, result) => {
if (parseErr) {
throw parseErr;
}
console.log(result);
});
});flexSvg.FlexSvg([options])
Return: Function
Create a function to which options are binded. This is more efficient way in the case when the program repeatedly runs flexSvg function with the same options.
License
Copyright (c) 2014 - 2017 Shinnosuke Watanabe
Licensed under the MIT License
