svg-path-commander 0.1.23 → 0.2.0-alpha1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/README.md +6 -4
  2. package/dist/svg-path-commander.es5.js +3948 -0
  3. package/dist/svg-path-commander.es5.min.js +2 -0
  4. package/dist/svg-path-commander.esm.js +438 -411
  5. package/dist/svg-path-commander.esm.min.js +2 -2
  6. package/dist/svg-path-commander.js +1455 -1530
  7. package/dist/svg-path-commander.min.js +2 -2
  8. package/package.json +15 -2
  9. package/src/convert/pathToAbsolute.js +4 -4
  10. package/src/convert/pathToCurve.js +2 -2
  11. package/src/convert/pathToRelative.js +4 -4
  12. package/src/convert/pathToString.js +2 -2
  13. package/src/math/polygonLength.js +1 -2
  14. package/src/options/options.js +1 -1
  15. package/src/parser/error.js +2 -0
  16. package/src/parser/finalizeSegment.js +1 -1
  17. package/src/parser/isSpace.js +1 -1
  18. package/src/parser/paramsParser.js +1 -1
  19. package/src/parser/parsePathString.js +6 -11
  20. package/src/parser/pathParser.js +1 -1
  21. package/src/parser/scanFlag.js +3 -3
  22. package/src/parser/scanParam.js +7 -6
  23. package/src/parser/scanSegment.js +3 -2
  24. package/src/parser/skipSpaces.js +1 -1
  25. package/src/process/clonePath.js +1 -1
  26. package/src/process/fixArc.js +1 -1
  27. package/src/process/fixPath.js +2 -2
  28. package/src/process/getSVGMatrix.js +3 -2
  29. package/src/process/normalizePath.js +3 -3
  30. package/src/process/normalizeSegment.js +2 -2
  31. package/src/process/optimizePath.js +2 -2
  32. package/src/process/projection2d.js +2 -2
  33. package/src/process/reverseCurve.js +3 -3
  34. package/src/process/reversePath.js +4 -5
  35. package/src/process/roundPath.js +7 -6
  36. package/src/process/segmentToCubic.js +3 -3
  37. package/src/process/shortenSegment.js +3 -3
  38. package/src/process/splitCubic.js +1 -1
  39. package/src/process/splitPath.js +1 -1
  40. package/src/process/transformPath.js +8 -7
  41. package/src/svg-path-commander.js +60 -20
  42. package/src/util/getClosestPoint.js +1 -1
  43. package/src/util/getCubicSize.js +1 -1
  44. package/src/util/getDrawDirection.js +1 -1
  45. package/src/util/getPathArea.js +1 -1
  46. package/src/util/getPathBBox.js +2 -2
  47. package/src/util/getPathLength.js +1 -1
  48. package/src/util/getPointAtLength.js +1 -1
  49. package/src/util/getPropertiesAtLength.js +5 -4
  50. package/src/util/getPropertiesAtPoint.js +5 -4
  51. package/src/util/getSegmentAtLength.js +2 -2
  52. package/src/util/getSegmentOfPoint.js +2 -2
  53. package/src/util/getTotalLength.js +1 -1
  54. package/src/util/isAbsoluteArray.js +1 -1
  55. package/src/util/isCurveArray.js +1 -1
  56. package/src/util/isNormalizedArray.js +1 -1
  57. package/src/util/isPathArray.js +1 -1
  58. package/src/util/isPointInStroke.js +2 -2
  59. package/src/util/isRelativeArray.js +1 -1
  60. package/src/util/pathLengthFactory.js +12 -10
  61. package/src/util/segmentArcFactory.js +6 -5
  62. package/src/util/segmentCubicFactory.js +6 -5
  63. package/src/util/segmentLineFactory.js +2 -2
  64. package/src/util/segmentQuadFactory.js +6 -5
  65. package/src/util/shapeToPath.js +14 -14
  66. package/src/util/util.js +0 -2
  67. package/types/index.d.ts +1 -3
  68. package/types/more/modules.ts +0 -3
  69. package/types/more/svg.d.ts +11 -10
  70. package/types/svg-path-commander.d.ts +218 -228
  71. package/src/util/createPath.js +0 -17
  72. package/src/util/getPointAtPathLength.js +0 -15
package/README.md CHANGED
@@ -1,4 +1,6 @@
1
- ![image](./assets/SVGPathCommander.svg)
1
+ # SVGPathCommander ![check-code-coverage](https://img.shields.io/badge/code--coverage-100%25-brightgreen)
2
+
3
+ ![image](./docs/assets/SVGPathCommander.svg)
2
4
 
3
5
  A modern set of ES6+ JavaScript tools for manipulating the `d` (description) attribute for *SVGPathElement* items. The library is implementing modern JavaScript API to produce reusable path strings with lossless quality. In addition, you also have a powerful tool to convert other SVG shapes like `<circle>` or `<rect>` to `<path>`.
4
6
 
@@ -45,10 +47,10 @@ Flip a path on the X axis:
45
47
  ```js
46
48
  import SVGPathCommander from 'svg-path-commander';
47
49
 
48
- const path = 'M0 0 L50 100';
50
+ const path = 'M0 0L100 0L50 100';
49
51
 
50
52
  const flippedPathString = new SVGPathCommander(path).flipX().toString();
51
- // result => 'M0 100L50 0'
53
+ // result => 'M0 100h100L50 0'
52
54
  ```
53
55
 
54
56
  Optimize a path string for best outcome by using the `round: 'auto'` option which will determine the amount of decimals based on the shape's bounding box:
@@ -167,7 +169,7 @@ For developer guidelines, and a complete list of static methods, head over to th
167
169
  * all 3d transformations as well as skews will convert `A` (arc) path commands to `C` (cubic bezier) due to the lack of resources;
168
170
  * most tools included with **SVGPathCommander** should work in your Node.js apps, but feel free to report any issue;
169
171
  * other path commands like `R` (catmulRomBezier), `O`, `U` (ellipse and shorthand ellipse) are not present in the current draft and are not supported;
170
- * normalization can mean many things to many people and our library is developed to convert path command values to absolute and shorthand to longshorthand commands to provide a solid foundation for the main processing tools of our library;
172
+ * normalization can mean many things to many people and our library is developed to convert path command values to absolute and shorthand to longhand commands to provide a solid foundation for the main processing tools of our library;
171
173
  * when compared to the native methods like `SVGPathElement.getTotalLength()` or `SVGPathElement.getPointAtLength()`, the output of our static methods is within a [0.002 - 0.05] margin delta, but from our experience it's proven to be a more consistent outcome.
172
174
 
173
175