svgo
Advanced tools
Package description
The svgo npm package is a Node.js-based tool for optimizing SVG vector graphics files. SVGO stands for Scalable Vector Graphics Optimizer. It works by applying a series of transformations and optimizations to SVG files to reduce their size without affecting their visual quality. This is particularly useful for web development, where smaller file sizes can lead to faster load times and better performance.
Minify SVG files
This feature allows you to minify SVG files by removing unnecessary data without affecting the rendering of the SVG. The code sample demonstrates how to use the optimize function to minify an SVG string.
const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, { path: 'path/to/svg/file.svg' });
console.log(result.data);Remove specified attributes
This feature allows you to remove specified attributes from SVG elements. The code sample shows how to use the removeAttributesBySelector plugin to remove the 'fill' attribute from all elements that have it.
const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, {
plugins: [
{
name: 'removeAttributesBySelector',
params: {
selector: '[fill]',
attributes: 'fill'
}
}
]
});
console.log(result.data);Prettify SVG files
This feature allows you to prettify SVG files by reformatting them with consistent indentation and spacing. The code sample demonstrates how to use the js2svg option with the pretty parameter set to true.
const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, {
plugins: [
'preset-default',
'sortAttrs',
{
name: 'removeAttrs',
params: { attrs: '(stroke|fill)' }
}
],
js2svg: { pretty: true }
});
console.log(result.data);imagemin-svgo is a plugin for Imagemin, which is a general image optimization framework. While svgo focuses solely on SVG files, Imagemin can handle various image formats when combined with the appropriate plugins. Imagemin-svgo brings the capabilities of svgo to the Imagemin ecosystem.
svg-sprite is a package that takes a set of SVG files and combines them into a single sprite sheet. While svgo optimizes individual SVG files, svg-sprite focuses on creating an efficient way to bundle multiple SVGs for use on the web.
svg-crowbar is a tool designed to extract SVG elements from an HTML document and download them as standalone SVG files. It is different from svgo, which optimizes existing SVG files rather than extracting them from HTML.
Readme
english | русский
SVG Optimizer is a Nodejs-based tool for optimizing SVG vector graphics files.
SVG files, especially those exported from various editors, usually contain a lot of redundant and useless information. This can include editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting the SVG rendering result.
SVGO has a plugin-based architecture, so almost every optimization is a separate plugin.
Today we have:
| Plugin | Description | Default |
|---|---|---|
| cleanupAttrs | cleanup attributes from newlines, trailing, and repeating spaces | enabled |
| inlineStyles | move and merge styles from <style> elements to element style attributes | enabled |
| removeDoctype | remove doctype declaration | enabled |
| removeXMLProcInst | remove XML processing instructions | enabled |
| removeComments | remove comments | enabled |
| removeMetadata | remove <metadata> | enabled |
| removeTitle | remove <title> | enabled |
| removeDesc | remove <desc> | enabled |
| removeUselessDefs | remove elements of <defs> without id | enabled |
| removeXMLNS | removes xmlns attribute (for inline svg) | disabled |
| removeEditorsNSData | remove editors namespaces, elements, and attributes | enabled |
| removeEmptyAttrs | remove empty attributes | enabled |
| removeHiddenElems | remove hidden elements | enabled |
| removeEmptyText | remove empty Text elements | enabled |
| removeEmptyContainers | remove empty Container elements | enabled |
| removeViewBox | remove viewBox attribute when possible | enabled |
| cleanupEnableBackground | remove or cleanup enable-background attribute when possible | enabled |
| minifyStyles | minify <style> elements content with CSSO | enabled |
| convertStyleToAttrs | convert styles into attributes | enabled |
| convertColors | convert colors (from rgb() to #rrggbb, from #rrggbb to #rgb) | enabled |
| convertPathData | convert Path data to relative or absolute (whichever is shorter), convert one segment to another, trim useless delimiters, smart rounding, and much more | enabled |
| convertTransform | collapse multiple transforms into one, convert matrices to the short aliases, and much more | enabled |
| removeUnknownsAndDefaults | remove unknown elements content and attributes, remove attrs with default values | enabled |
| removeNonInheritableGroupAttrs | remove non-inheritable group's "presentation" attributes | enabled |
| removeUselessStrokeAndFill | remove useless stroke and fill attrs | enabled |
| removeUnusedNS | remove unused namespaces declaration | enabled |
| prefixIds | prefix IDs and classes with the SVG filename or an arbitrary string | disabled |
| cleanupIDs | remove unused and minify used IDs | enabled |
| cleanupNumericValues | round numeric values to the fixed precision, remove default px units | enabled |
| cleanupListOfValues | round numeric values in attributes that take a list of numbers (like viewBox or enable-background) | disabled |
| moveElemsAttrsToGroup | move elements' attributes to their enclosing group | enabled |
| moveGroupAttrsToElems | move some group attributes to the contained elements | enabled |
| collapseGroups | collapse useless groups | enabled |
| removeRasterImages | remove raster images | disabled |
| mergePaths | merge multiple Paths into one | enabled |
| convertShapeToPath | convert some basic shapes to <path> | enabled |
| convertEllipseToCircle | convert non-eccentric <ellipse> to <circle> | enabled |
| sortAttrs | sort element attributes for epic readability | disabled |
| sortDefsChildren | sort children of <defs> in order to improve compression | enabled |
| removeDimensions | remove width/height and add viewBox if it's missing (opposite to removeViewBox, disable it first) | disabled |
| removeAttrs | remove attributes by pattern | disabled |
| removeAttributesBySelector | removes attributes of elements that match a css selector | disabled |
| removeElementsByAttr | remove arbitrary elements by ID or className | disabled |
| addClassesToSVGElement | add classnames to an outer <svg> element | disabled |
| addAttributesToSVGElement | adds attributes to an outer <svg> element | disabled |
| removeOffCanvasPaths | removes elements that are drawn outside of the viewbox | disabled |
| removeStyleElement | remove <style> elements | disabled |
| removeScriptElement | remove <script> elements | disabled |
| reusePaths | Find duplicated elements and replace them with links | disabled |
Want to know how it works and how to write your own plugin? Of course you want to. (동작방법)
$ [sudo] npm install -g svgo
Usage:
svgo [OPTIONS] [ARGS]
Options:
-h, --help : Help
-v, --version : Version
-i INPUT, --input=INPUT : Input file, "-" for STDIN
-s STRING, --string=STRING : Input SVG data string
-f FOLDER, --folder=FOLDER : Input folder, optimize and rewrite all *.svg files
-o OUTPUT, --output=OUTPUT : Output file or folder (by default the same as the input), "-" for STDOUT
-p PRECISION, --precision=PRECISION : Set number of digits in the fractional part, overrides plugins params
--config=CONFIG : Config file to customize default behavior
--datauri=DATAURI : Output as Data URI string (base64, URI encoded or unencoded)
--multipass : Pass over SVGs multiple times to ensure all optimizations are applied
--pretty : Make SVG pretty printed
--indent=INDENT : Indent number when pretty printing SVGs
-r, --recursive : Use with '-f'. Optimizes *.svg files in folders recursively.
-q, --quiet : Only output error messages, not regular status messages
--show-plugins : Show available plugins and exit
Arguments:
INPUT : Alias to --input
with files:
$ svgo test.svg
or:
$ svgo *.svg
Windows does not support glob expansion. The command above will not work on Windows.
$ svgo test.svg -o test.min.svg
$ svgo test.svg other.svg third.svg
$ svgo test.svg other.svg third.svg -o test.min.svg -o other.min.svg -o third.min.svg
with STDIN / STDOUT:
$ cat test.svg | svgo -i - -o - > test.min.svg
with folder
$ svgo -f ../path/to/folder/with/svg/files
or:
$ svgo -f ../path/to/folder/with/svg/files -o ../path/to/folder/with/svg/output
$ svgo *.svg -o ../path/to/folder/with/svg/output
with strings:
$ svgo -s '<svg version="1.1">test</svg>' -o test.min.svg
or even with Data URI base64:
$ svgo -s 'data:image/svg+xml;base64,...' -o test.min.svg
with SVGZ:
from .svgz to .svg:
$ gunzip -c test.svgz | svgo -i - -o test.min.svg
from .svg to .svgz:
$ svgo test.svg -o - | gzip -cfq9 > test.svgz
 |  |
|---|---|
| SheetJS LLC | Fontello |
This software is released under the terms of the MIT license.
Logo by Yegor Bolshakov.
FAQs
Nodejs-based tool for optimizing SVG vector graphics files
We found that svgo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.