svg-parser

What is svg-parser?

The svg-parser npm package is a utility for parsing SVG (Scalable Vector Graphics) files into a JavaScript object representation. This can be useful for manipulating or analyzing SVG content programmatically.

What are svg-parser's main functionalities?

Parsing SVG to JavaScript Object

This feature allows you to parse an SVG string into a JavaScript object. The resulting object can then be manipulated or analyzed as needed.

const { parse } = require('svg-parser');
const svg = '<svg><circle cx="50" cy="50" r="40" /></svg>';
const result = parse(svg);
console.log(result);

Other packages similar to svg-parser

svgson

svgson is a library that converts SVG into a JSON object and vice versa. It offers more advanced features like transforming the SVG structure and manipulating attributes, making it more versatile compared to svg-parser.

svgo

SVGO (SVG Optimizer) is a tool for optimizing SVG files by removing unnecessary data. While it focuses on optimization rather than parsing, it can still be used to manipulate SVG content programmatically, offering a different set of functionalities compared to svg-parser.

xml2js

xml2js is a library for converting XML to JavaScript objects and vice versa. Since SVG is XML-based, xml2js can be used to parse SVG files, although it is a more general-purpose XML parser and lacks SVG-specific features.

README

svg-parser

Take a string representing an SVG document or fragment, turn it into HAST JavaScript object.

Installation

npm install svg-parser, or grab it from npmcdn.com/svg-parser.

Usage

import { parse } from 'svg-parser';

const parsed = parse( `
	<svg viewBox='0 0 100 100'>
		<!-- stuff goes here... -->
	</svg>
` );
/*
{
  type: 'root',
  children: [
    {
      type: 'element',
      tagName: 'svg',
      properties: {
        viewBox: '0 0 100 100'
      },
      children: [...]
    }
  ]
}
*/

License

MIT