Unclaimed project
Are you a maintainer of svgo? Claim this project to take control of your public changelog and roadmap.
This is a release candidate. We are still working on v4.0.0, and API stability isn't guaranteed, though we'll aim to keep it fairly consistent. You can try this build by installing or depending on svgo@4.0.0-rc.0, or svgo@rc.
Please report any problems you encounter in the GitHub issue tracker. 👍🏽
A summary, if you use the browser bundle of SVGO, or import/require anything except the base svgo path, such as svgo/lib/builtin, then you will very likely have to make code changes to update to version 4.
Node.js v14 is no longer supported by the Node.js team, including security support since 30 April 2023. Node.js v16 is no longer supported either, but as many are still using it, we'll continue to support Node.js v16 for now.
This allows us to update our dependencies to more recent versions, and to access more modern Node.js APIs.
Node.js v14 may still work at the time of this release, but we'll no longer be testing against v14 from now on.
We now enforce boundaries between the intended public API and any internal structures/helpers.
There are two ways to import SVGO:
svgo — for normal usage, such as scripts or server-side applications.svgo/browser — for browser usage.If you use the browser bundle, you must amend how you import SVGO:
- import { optimize } from 'svgo/dist/svgo.browser.js';
+ import { optimize } from 'svgo/browser';
For all interfaces, it's recommended to use our named exports:
// ESM and Browser, named exports
import { VERSION } from 'svgo';
console.log(VERSION); // 4.0.0-rc.0
// ESM and Browser, import all
import * as svgo from 'svgo/browser';
console.log(svgo.VERSION); // 4.0.0-rc.0
// Common JS, default export
const SVGO = require('svgo');
console.log(SVGO.VERSION); // 4.0.0-rc.0
// CommonJS, named exports
const { VERSION } = require('svgo');
console.log(VERSION); // 4.0.0-rc.0
We support 3 environments, ESM, Common JS, and browser. The only functional difference is that the loadConfig function is not exported in the browser bundle.
If you import/require the array of built-in plugins, or a single plugin during runtime, this is now a top-level export instead:
// builtin.mjs - get an array of all built-in plugins
- import { builtin } from 'svgo/lib/builtin';
+ import { builtinPlugins } from 'svgo'
// plugin.mjs - get a single plugin
- import presetDefault from 'svgo/plugins/preset-default';
+ import { builtinPlugins } from 'svgo';
+ const prefixDefault = builtinPlugins.find(plugin => plugin.name === 'preset-default');
// plugin-map.mjs - get all plugins as a map using the plugin name as a key
import { builtinPlugins } from 'svgo';
const pluginMap = builtinPlugins.reduce((acc, val) => acc.set(val.name, val), new Map());
Both removeViewBox and removeTitle have been disabled by default. Both have been major pain points for users, and don't make sense to enable in most cases. Other libraries wrapping SVGO have also been disabling these plugins by default, such as Docusaurus and SVGR.
If you would like either of these plugins enabled, you can do so by configuring it in the SVGO config, see the README for more context:
export default {
plugins: [
'preset-default', // built-in plugins enabled by default
+ 'removeViewBox',
+ 'removeTitle',
],
};
The removeScriptElement plugin has been renamed to removeScripts, to more accurately reflect what the plugin does. It does not only remove the <script> tag, but also event handlers and script URIs from links.
To migrate, amend your SVGO config to refer to removeScripts instead if you use that plugin.
export default {
plugins: [
'preset-default', // built-in plugins enabled by default
- 'removeScriptElement',
+ 'removeScripts',
],
};
SVGO is now a dual package, serving for both Common JS and ESM usage. To be more explicit, SVGO will continue to work in Common JS projects!
Thanks to @jdufresne for doing the bulk of the work.
convertCase to false.filter attribute. By @johnkenny54 in #1933path[opacity=0] as a non-rendering node. By @johnkenny54 in #1948-o argument) ends with a trailing slash to a location that didn't exist. By @SethFalco in #1954VERSION export so get the version of SVGO during runtime. By @SethFalco in #2016isPreset and plugins property to plugins, which are only defined for presets. This will indicate if the plugin is a preset, and return the plugins that in the preset in the order they are invoked.Before and after using vectors from various sources, with the default preset of each respective version:
| SVG | Original | v3.3.2 | v4.0.0-rc.0 | Delta | |---|---|---|---|---| | Arch Linux Logo | 9.529 KiB | 4.115 KiB | 4.097 KiB | ⬇️ 0.018 KiB | | Blobs | 50.45 KiB | 42.623 KiB | 42.633 KiB | ⬆️ 0.01 KiB | | Isometric Madness | 869.034 KiB | 540.582 KiB | 540.141 KiB | ⬇️ 0.441 KiB | | tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | | | Wikipedia Logo | 161.551 KiB | 111.668 KiB | 111.727 KiB | ⬆️ 0.059 KiB |
Note: The increase in size from previous versions is from disabling removeViewBox and removeTitle, with the benefit of preserving scalability and accessibility.
Before and after of the browser bundle of each respective version:
| | v3.3.2 | v4.0.0-rc.0 | Delta | |---|---|---|---| | svgo.browser.js | 753.0 kB | 754.9 kB | ⬆️ 1.9 kB |