svg-protect
v1.0.6
Published
Flatten, optimise, CC Lisence and split paths to prevent Illustrators from changing your work without permission.
Downloads
8
Maintainers
Readme
svg-protect
Illustrator/Publisher proof your svgs before downloading.
Installation
npm install svg-protect
Usage
const svgp = require('svg-protect');
var svg = document.getElementById('mysvg')
svgp(svg,{
owner:"Dan Ellis <[email protected]>",
flatten:true,
elementids: "",
split:false,
cclicense:true,
cclogo:true,
savestyle: "svge" // "svge|svg|png"
savebtn:true
})
1. Flatten -
Removes groups and adds all elements to base svg
2. Element IDS -
Overwrites element IDS
3. Split -
Applies @mattdesl's triangle style splitting of paths to svg
4. CC license -
Appends the creative commons licence to svg as a comment.
5. Save Style-
Set save style from svge|svg|png
6. Save Button -
Create a button you can click to save your work. id = savebtn
Saving functions written with the help of the SVG Jimmy crowbar bookmarks: https://nytimes.github.io/svg-crowbar/
Process
This program takes several steps to attempt to protect an svg. These are:
- Flatten all group elements into main svg body.
- Optimise svg code and convert all elements into Paths.
- Rename all svg element ids to state ownership.
- Split paths into triangles.
- Add CC Attribution licence within svg comments.
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.