Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
By Sarah Gooding - Feb 07, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
svgstore
Combines multiple SVG files into one using <symbol> elements which you may <use> in your markup. Heavily inspired by grunt-svgstore and gulp-svgstore, this is a standalone module that may be used in any asset pipeline.
Install
$ npm install --save svgstore
Usage
var svgstore = require('svgstore');
var fs = require('fs');
var sprites = svgstore()
.add('unicorn', fs.readFileSync('./unicorn.svg', 'utf8'))
.add('rainbow', fs.readFileSync('./rainbow.svg', 'utf8'));
fs.writeFileSync('./sprites.svg', sprites);
The resulting file may be consumed in markup as external content.
<body>
<svg role="img"><use xlink:href="./sprites.svg#unicorn"/></svg>
<svg role="img"><use xlink:href="./sprites.svg#rainbow"/></svg>
</body>
See the examples directory for more detail.
API
svgstore([options]): SvgStore
options{Object}: Options for converting SVGs to symbols
Creates a container SVG sprites document.
.element
The current cheerio instance.
.add(id, svg [, options]): SvgStore
id{String}Uniqueidfor this SVG file.svg{String}Raw source of the SVG file.options{Object}Same as the options ofsvgstore(), but will only apply to this SVG file's<symbol>.
Appends a file to the sprite with the given id.
.toString([options]): String
options{Object}inline{Boolean}(default:false) Don't output<?xml ?>,DOCTYPE, and thexmlnsattribute.
Outputs sprite as a string of XML.
Options
cleanDefs{Boolean|Array}(default:false) Removestyleattributes from SVG definitions, or a list of attributes to remove.cleanSymbols{Boolean|Array}(default:false) Removestyleattributes from SVG objects, or a list of attributes to remove.svgAttrs{Boolean|Object}(default:false) A map of attributes to set on the root<svg>element. If you set an attribute's value to null, you remove that attribute. Values may be functions like jQuery.symbolAttrs{Boolean|Object}(default:false) A map of attributes to set on each<symbol>element. If you set an attribute's value to null, you remove that attribute. Values may be functions like jQuery.copyAttrs{Boolean|Array}(default:false) Attributes to havesvgstoreattempt to copy to the newly created<symbol>tag from it's source<svg>tag. TheviewBox,aria-labelledby, androleattributes are always copied.renameDefs{Boolean}(default:false) Renamedefscontent ids to make them inherit files' names so that it would help to avoid defs with same ids in the output file.
Contributing
Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.
Test
$ npm test
Future Goals
The svgstore organization began after it was noticed that the common build task of converting an <svg> into a <symbol> tag was being implemented in a similar manner by many different projects across the JavaScript ecosystem.
The long-term goal for this project, in particular, is to provide a single standalone module that can be plugged in to any asset pipeline, thus allowing pipeline tools to focus on providing clean APIs and interfaces related to their build process integration, rather than implementing/duplicating SVG conversion logic directly.
Current build tools using svgstore:
MIT © Shannon Moeller
FAQs
Combines mulitple svg files into one.
The npm package svgstore receives a total of 27,250 weekly downloads. As such, svgstore popularity was classified as popular.
We found that svgstore demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Package last updated on 27 Sep 2018
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Linux Foundation Warns Open Source Developers: Compliance with Sanctions Is Not Optional
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
By Sarah Gooding - Feb 06, 2025
Security News
Maven Central Adds Sigstore Signature Validation
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.
By Sarah Gooding - Feb 06, 2025