Git Product home page Git Product logo

svg-parse's Introduction

svg-parse

Parses SVG paths to a consumable object and JSON

Installation

Use NPM to install it into your project:

npm install --save svg-parse

Usage

Parsing

Use the exported parse function to parse an SVG path to JSON:

const { parse } = require('svg-parse');

const path = parse('M10 20 L20 20 h10 Z');
console.dir(path);

The result will be:

[ { type: 'moveTo', props: { relative: false, x: 10, y: 20 } },
  { type: 'lineTo', props: { relative: false, x: 20, y: 20 } },
  { type: 'horizontal', props: { relative: true, x: 10 } },
  { type: 'close', props: null } ]

Generalization

You can also generalize SVG paths to restrict them to moveTo, lineTo, curveTo, and arc commands, which are easier to draw:

const { parse } = require('svg-parse');

const path = parse('M10 20 L20 20 h10 Z', { generalize: true });
console.dir(path);

The result will be:

[ { type: 'moveTo', props: { relative: false, x: 10, y: 20 } },
  { type: 'lineTo', props: { relative: false, x: 20, y: 20 } },
  // Compare with result above!
  { type: 'lineTo', props: { relative: true, x: 10, y: 0 } },
  { type: 'close', props: null } ]

Changelog

Please take a look at changes in the CHANGELOG.md.

svg-parse's People

Contributors

dependabot[bot] avatar ksm2 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

oracimaru

svg-parse's Issues

parse.js is missing

just installed this package to take a look at it,

index.js fails in importing parse.js

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.