Skip to content

fcaylus/sssvg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Super Slim SVG (sssvg)

npm version

Optimize SVGs and create Super Slim SVGs ! (based on svgo)

Applies 10 passes of SVGO (with aggressive parameters), crop the svg to its content, and resize the viewBox as you want !

Not optimized for speed at all, make take a whole second to process 🐌

Features

  • Optimize SVGs
  • Crop the SVG to its content
  • Resize the viewBox (with the same aspect ratio, or not, as you want !)
  • Analyze the SVG for raster images, text, colors, ...

How to use it ?

  • CLI
Usage: sssvg [options] <input> <output>

Optimize SVGs and create Super Slim SVGs !

Arguments:
  input                                Input SVG file
  output                               Output SVG file or directory (if it doesn't match *.svg)

Options:
  -V, --version                        output the version number
  -d, --directory                      Treat input as a directory and optimize all SVGs inside
  -r, --recursive                      Explore input directory recursively. Requires -d or --directory
  -c, --crop                           Crop SVGs to its content, and change the view box accordingly
  -b, --background <background-color>  Background color. Used for cropping to content. Can be either "transparent", an HTML color name or a HEX string (starting with #) (default: "default")
  --view-box <viewBox>                 Change the viewBox to match the one provided (and resize the SVG accordingly). Shorthand for --x, --y, --width and --height together
  --x <x>                              Change the x value of the viewBox
  --y <y>                              Change the y value of the viewBox
  --width <width>                      Change the width value of the viewBox
  --height <height>                    Change the height value of the viewBox
  -a, --analyze                        Display analysis information about the SVG
  -h, --help                           display help for command
  • Node.js
const fs = require('fs');
const { optimizeSVG, analyzeSVG } = require('sssvg');

const svgFileData = fs.readFileSync('test.svg', 'utf8');
const optimizedSvg = await optimizeSVG('test.svg', svgFileData, { 
    crop: true,
    backgroundColor: 'black',
    viewBox: {
        x: 0,
        y: 0,
        height: 1000,
        // Will preserve aspect ratio
        width: undefined
    }
});
const analysis = analyzeSVG(svgFileData);

console.log(`Analysis: ${analysis}`);
console.log(`Optimized SVG: ${optimizedSvg}`);

How it works ?

  • For optimizing SVGs content, svgo library is used
  • For cropping to content, the SVG is first converted to a high quality PNG (width & height > 1000px), then the content bounding box is computed based on the background color (by default, it's "transparent" or "white").
  • For viewBox resizing, the SVG is converted to a JSON AST, and the transformation is applied to every path commands.

Licence

Licensed under the MIT license. See LICENSE file for more info.