svgo-add-viewbox

SVGO plugin which adds "viewBox" attribute based on "width" and "height" attributes

MIT License

Downloads
7.1K
Stars
6
Committers
2

SVGO Add viewBox

An SVGO plugin to add viewBox attribute based on width and height attributes

Visitor stats

Code stats

This plugin adds the viewBox attribute to your SVGs based on the width and height attributes. The difference between this plugin and the built-in removeDimensions plugin is that svgo-add-viewbox does not remove the width and height of your SVGs.

In order to use this plugin correctly, your SVGs should have their width and height attributes specified.

Usage

v2.x.x or 3.x.x of this plugin should be used with SVGO v3 and above.

v1.x.x of this plugin should be used with SVGO v2.

  1. Create a svgo.config.js file following the official configuration guide
  2. Use the option to specify a custom plugin.
  3. Install this module from NPM
npm install svgo-add-viewbox --save-dev
# or
yarn add svgo-add-viewbox -D
  1. import the module in your svgo.config.js file:
import addViewBox from 'svgo-add-viewbox';
  1. In the plugins array in your svgo.config.js file add the following:
plugins: [
	// ... more plugins
	addViewBox
	// ... more plugins
];
  1. Arguments
  • overwrite - boolean - defaults to true - If set to false will preserve any existing viewBox attribute on your input SVG files.

Usage:

plugins: [
	// ... more plugins
	{
		...addViewBox,
		params: {
			overwrite: false
		}
	}
	// ... more plugins
];
  1. Execute your SVG transformation NPM script.

LICENSE

MIT



Package Rankings
Top 19.05% on Npmjs.org
Badges
Extracted from project README
Github Build Codacy Badge Codebeat Badge CodeFactor Badge DeepScan grade Analytics