<div align="center">

<img src="./logo/logo-web.svg" width="348.61" height="100" alt="SVGO logo"/>

</div>

SVGO  

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

Why?

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.

Installation

sh
npm -g install svgo

or

sh
yarn global add svgo

CLI usage

sh
svgo one.svg two.svg -o one.min.svg two.min.svg

Or use the --folder/-f flag to optimize a whole folder of SVG icons

sh
svgo -f ./path/to/folder/with/svg/files -o ./path/to/folder/with/svg/output

See help for advanced usage

sh
svgo --help

Configuration

Some options can be configured with CLI though it may be easier to have the configuration in a separate file. SVGO automatically loads configuration from svgo.config.js or module specified with --config flag.

js
module.exports = {
  multipass: true, // boolean. false by default
  datauri: 'enc', // 'base64', 'enc' or 'unenc'. 'base64' by default
  js2svg: {
    indent: 2, // string with spaces or number of spaces. 4 by default
    pretty: true, // boolean, false by default
  },
};

SVGO has a plugin-based architecture, so almost every optimization is a separate plugin. There is a set of [built-in plugins](#built-in-plugins). See how to configure them:

js
module.exports = {
  plugins: [
    // enable a built-in plugin by name
    'prefixIds',

    // or by expanded version
    {
      name: 'prefixIds',
    },

    // some plugins allow/require to pass options
    {
      name: 'prefixIds',
      params: {
        prefix: 'my-prefix',
      },
    },
  ],
};

The default preset of plugins is fully overridden if the plugins field is specified. Use preset-default plugin to customize plugins options.

js
module.exports = {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          // customize options for plugins included in preset
          inlineStyles: {
            onlyMatchedOnce: false,
          },

          // or disable plugins
          removeDoctype: false,
        },
      },
    },

    // enable builtin plugin not included in default preset
    'prefixIds',

    // enable and configure builtin plugin not included in preset
    {
      name: 'sortAttrs',
      params: {
        xmlnsOrder: 'alphabetical',
      },
    },
  ],
};

Default preset includes the following list of plugins:

• removeDoctype
• removeXMLProcInst
• removeComments
• removeMetadata
• removeEditorsNSData
• cleanupAttrs
• mergeStyles
• inlineStyles
• minifyStyles
• cleanupIDs
• removeUselessDefs
• cleanupNumericValues
• convertColors
• removeUnknownsAndDefaults
• removeNonInheritableGroupAttrs
• removeUselessStrokeAndFill
• removeViewBox
• cleanupEnableBackground
• removeHiddenElems
• removeEmptyText
• convertShapeToPath
• convertEllipseToCircle
• moveElemsAttrsToGroup
• moveGroupAttrsToElems
• collapseGroups
• convertPathData
• convertTransform
• removeEmptyAttrs
• removeEmptyContainers
• mergePaths
• removeUnusedNS
• sortDefsChildren
• removeTitle
• removeDesc

It's also possible to specify a custom plugin:

js
const anotherCustomPlugin = require('./another-custom-plugin.js');
module.exports = {
  plugins: [
    {
      name: 'customPluginName',
      type: 'perItem', // 'perItem', 'perItemReverse' or 'full'
      params: {
        optionName: 'optionValue',
      },
      fn: (ast, params, info) => {},
    },
    anotherCustomPlugin,
  ],
};

API usage

SVGO provides a few low level utilities.

optimize

The core of SVGO is optimize function.

js
const { optimize } = require('svgo');
const result = optimize(svgString, {
  // optional but recommended field
  path: 'path-to.svg',
  // all config fields are also available here
  multipass: true,
});
const optimizedSvgString = result.data;

loadConfig

If you write a tool on top of SVGO you might need a way to load SVGO config.

js
const { loadConfig } = require('svgo');
const config = await loadConfig();

// you can also specify a relative or absolute path and customize the current working directory
const config = await loadConfig(configFile, cwd);

Built-in plugins

Other Ways to Use SVGO

• as a web app – SVGOMG
• as a GitHub Action – SVGO Action
• as a Grunt task – grunt-svgmin
• as a Gulp task – gulp-svgmin
• as a Mimosa module – mimosa-minify-svg
• as an OSX Folder Action – svgo-osx-folder-action
• as a webpack loader – image-webpack-loader
• as a Telegram Bot – svgo_bot
• as a PostCSS plugin – postcss-svgo
• as an Inkscape plugin – inkscape-svgo
• as a Sketch plugin - svgo-compressor
• as a macOS app - Image Shrinker
• as a Rollup plugin - rollup-plugin-svgo
• as a VS Code plugin - vscode-svgo
• as a Atom plugin - atom-svgo
• as a Sublime plugin - Sublime-svgo
• as a Figma plugin - Advanced SVG Export
• as a Linux app - Oh My SVG
• as a Browser extension - SVG Gobbler
• as an API - Vector Express

Donators

License and Copyright

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

Logo by André Castillo.