JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12956
  • Score
    100M100P100Q135986F
  • License MIT

ES6+ JavaScript tools for manipulating SVG path data

Package Exports

  • svg-path-commander
  • svg-path-commander/src/convert/pathToAbsolute.js
  • svg-path-commander/src/convert/pathToCurve.js
  • svg-path-commander/src/convert/pathToString.js
  • svg-path-commander/src/math/distanceSquareRoot.js
  • svg-path-commander/src/math/epsilon.js
  • svg-path-commander/src/math/midPoint.js
  • svg-path-commander/src/process/clonePath.js
  • svg-path-commander/src/process/normalizePath.js
  • svg-path-commander/src/process/parsePathString.js
  • svg-path-commander/src/process/reverseCurve.js
  • svg-path-commander/src/process/roundPath.js
  • svg-path-commander/src/process/splitCubic.js
  • svg-path-commander/src/process/splitPath.js
  • svg-path-commander/src/util/createPath.js
  • svg-path-commander/src/util/getDrawDirection.js
  • svg-path-commander/src/util/getPathLength.js
  • svg-path-commander/src/util/getPointAtLength.js
  • svg-path-commander/src/util/getSegCubicLength.js
  • svg-path-commander/src/util/invalidPathValue.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (svg-path-commander) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SVG Path Commander

SVG Path Commander

A modern set of ES6+ JavaScript tools for manipulating the d (description) attribute for SVGPathElement items, and is implementing modern JavaScript API to produce reusable path strings with lossless quality.

While you may find familiar tools inside, this library brings new additions:

  • a tool that can reverse path draw direction without altering path commands, even with specific shorthand path commands;
  • a unique tool that can reverse path draw direction for path strings with only 'C' path commands;
  • a new and unique tool to apply transform functions to path commands via the modern DOMMatrix API.

The key differences with other libraries:

  • ES6+ sourced with modernized codebase and build tools; all inherited codebase has been modernized as well;
  • you can use this library in both web apps and Node.js, where others are restricted to a single environment;
  • path command transformations are all consistent with the SVG coordinates system, where others compute transform origin only for rotation transformation;
  • as you will see below, our library can create 3D to 2D projections, making your SVGs look like 3D but in the SVG coordinate system.

SVGPathCommander implements the DOMMatrix API for SVGPathElement path command transformation and falls back to a modernized CSSMatrix shim on older browsers as well as Node.js. There are a couple of good reasons for this implementation:

  • WebKitCSSMatrix and SVGMatrix APIs are slowly pushed away by DOMMatrix, the green light for new and modern implementations;
  • we can actually apply a 3D transformation matrix to SVG path commands, by calculating a 2D projection of the actual shape in 3D coordinates;
  • when most tools available will be rendered absolete, we are ready for new challenges.

This library is available on CDN and npm.

NPM Version NPM Downloads jsDeliver

WIKI

For developer guidelines, head over to the wiki pages.

What Is It For?

  • converting and optimizing SVGPathElement for use in third party application; our KUTE.js animation engine is using it to process SVGPathElement coordinates for SVG morphing and SVG cubic morphing;
  • animators that work with SVGs and need tools for performing specific path command processing;
  • font-icon creators can use it in both Node.js and web applications to process and test their creations.

ESLint

Some of the sources for the library recommend using the following ESLint rule:

rules: {
  // Disable bitwise for isArcCommand & isPathCommand
  "no-bitwise": 0,
}

Technical Considerations

  • as already mentioned, the optimize() method will not simplify/merge the path commands or determine and create shorthand notations; you might need SVGO and its convertPathData plugin; however, while computing path command values, the library will try to deliver the best outcome in path reverse or transformation;
  • all tools processing path segments will always round float values to 3 decimals; EG: 0.5666 => 0.566, 0.50 => 0.5; you can change the default option with SVGPathCommander.options.decimals = 2 or remove the value rounding all together with SVGPathCommander.options.round = 0; you can also control this feature via instance options;
  • the getSVGMatrix utility we developed will always compute the matrix by applying the transform functions in the following order: translate, rotate, skew and scale, which is the default composition/recomposition order specified in the W3C draft;
  • the 3d transformations will convert A (arc) path commands to C (cubic bezier) due to the lack of resources on 3D to 2D projection;
  • most tools included with SVGPathCommander should work in your Node.js apps, but if you choose to use other complimentary 3rd party libraries, make sure you have the proper tools for them;
  • other path commands like R (catmulRomBezier), O, U (ellipse and shorthand ellipse) are not present in the current draft and they are not supported;
  • normalization can mean many things to many people and our library is developed to convert path command values to absolute and shorthand to non-shorthand commands to provide a solid foundation for the main processing tools of our library.

Special Thanks

License

SVGPathCommander is released under MIT Licence.