Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svgstore/svgstore
Combines multiple svg files into one.
https://github.com/svgstore/svgstore
Last synced: about 2 months ago
JSON representation
Combines multiple svg files into one.
- Host: GitHub
- URL: https://github.com/svgstore/svgstore
- Owner: svgstore
- License: mit
- Created: 2016-03-09T20:51:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-18T14:44:21.000Z (about 2 years ago)
- Last Synced: 2024-07-14T05:42:44.942Z (2 months ago)
- Language: JavaScript
- Homepage: http://npm.im/svgstore
- Size: 236 KB
- Stars: 181
- Watchers: 3
- Forks: 39
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# svgstore
[![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url]
Combines multiple SVG files into one using `` elements which you may [`` in your markup](https://css-tricks.com/svg-sprites-use-better-icon-fonts/). Heavily inspired by [`grunt-svgstore`](https://github.com/FWeinb/grunt-svgstore) and [`gulp-svgstore`](https://github.com/w0rm/gulp-svgstore), this is a standalone module that may be [used in any asset pipeline](#future-goals).
## Install
$ npm install --save svgstore
## Usage
```js
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.
```html
```
See the [examples directory](https://github.com/shannonmoeller/svgstore/tree/master/docs/examples) for more detail.
## API
### svgstore([options]): SvgStore
- `options` `{Object}`: [Options for converting SVGs to symbols](#svgstore-options)
Creates a container SVG sprites document.
### .element
The current [cheerio](https://github.com/cheeriojs/cheerio) instance.
### .add(id, svg [, options]): SvgStore
- `id` `{String}` Unique `id` for this SVG file.
- `svg` `{String}` Raw source of the SVG file.
- `options` `{Object}` Same as the [options of `svgstore()`](#svgstore-options), but will only apply to this SVG file's ``.
Appends a file to the sprite with the given `id`.
### .toString([options]): String
- `options` `{Object}`
- `inline` `{Boolean}` (default: `false`) Don't output ``, `DOCTYPE`, and the `xmlns` attribute.
Outputs sprite as a string of XML.
- `cleanDefs` `{Boolean|Array}` (default: `false`) Remove `style` attributes from SVG definitions, or a list of attributes to remove.
- `cleanSymbols` `{Boolean|Array}` (default: `false`) Remove `style` attributes from SVG objects, or a list of attributes to remove.
- `svgAttrs` `{Boolean|Object}` (default: `false`) A map of attributes to set on the root `` 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 `` 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 have `svgstore` attempt to copy to the newly created `` tag from it's source `` tag. The `viewBox`, `aria-labelledby`, and `role` attributes are always copied.
- `renameDefs` `{Boolean}` (default: `false`) Rename `defs` content 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 `` into a `` tag](https://css-tricks.com/svg-symbol-good-choice-icons/) 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`:
* [broccoli-svgstore][broccoli-svgstore]
* [svgstore-cli][svgstore-cli]
----
MIT © [Shannon Moeller](http://shannonmoeller.com)
[downloads-img]: http://img.shields.io/npm/dm/svgstore.svg?style=flat-square
[npm-img]: http://img.shields.io/npm/v/svgstore.svg?style=flat-square
[npm-url]: https://npmjs.org/package/svgstore
[broccoli-svgstore]: https://github.com/svgstore/broccoli-svgstore
[svgstore-cli]: https://github.com/svgstore/svgstore-cli