svgo

What is svgo?

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.

What are svgo's main functionalities?

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);

Other packages similar to svgo

imagemin-svgo

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

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

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 | русский

---

SVGO v0.2.1

SVG Optimizer is a Nodejs-based tool for optimizing SVG vector graphics files.

Why?

SVG files, especially exported from various editors, usually contains a lot of redundant and useless information such as editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting SVG rendering result.

What it can do

SVGO has a plugin-based architecture, so almost every optimization is a separate plugin.

Today we have:

• [ > ] cleanup attributes from newlines, trailing and repeating spaces
• [ > ] remove doctype declaration
• [ > ] remove XML processing instructions
• [ > ] remove comments
• [ > ] remove <metadata>
• [ > ] remove editors namespaces, elements and attributes
• [ > ] remove empty attributes
• [ > ] remove hidden elements
• [ > ] remove empty Text elements
• [ > ] remove empty Container elements
• [ > ] remove viewBox attribute when possible
• [ > ] remove or cleanup enable-background attribute when possible
• [ > ] convert styles into attributes
• [ > ] convert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)
• [ > ] convert Path data to relative, convert one segment to another, trim useless delimiters and much more
• [ > ] collapse multiple transforms into one, convert matrices to the short aliases and much more
• [ > ] remove unknown elements content and attributes, remove attrs with default values
• [ > ] remove unused namespaces declaration
• [ > ] remove unused and minify used IDs
• [ > ] round numeric values to the fixed precision, remove default 'px' units
• [ > ] move elements attributes to the existing group wrapper
• [ > ] move some group attributes to the content elements
• [ > ] collapse useless groups

Want to know how it works and how to write your own plugin? Of course you want to.

How to use

$ [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 (by default the same as the input), "-" for STDOUT
  -c CONFIG, --config=CONFIG : Local config file to extend default
  --disable=DISABLE : Disable plugin by name
  --enable=ENABLE : Enable plugin by name
  --datauri : Output as Data URI base64 string
  --pretty : Make SVG pretty printed

Arguments:
  INPUT : Alias to --input
  OUTPUT : Alias to --output

• with files:

    $ svgo test.svg
  

  or:

    $ svgo test.svg test.min.svg
  

• with STDIN / STDOUT:

    $ cat test.svg | svgo -i - -o - > test.min.svg
  

• with folder

    $ svgo -f ../path/to/folder/with/svg/files
  

• 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
  

• with GUI – svgo-gui

• as a Nodejs module – examples

• as a Grunt task – svgo-grunt

• as an OSX Folder Action – svgo-osx-folder-action

TODO

• v0.2.x

License and copyrights

This software is released under the terms of the MIT license.

Logo by Yegor Bolshakov.