svg-path-simplify 0.2.7 → 0.3.4

package/README.md

@@ -32,6 +32,7 @@ Unlike most existing approaches (e.g in graphic applications), it checks where s
 * adaptive coordinate rounding: small or large details can be auto-detected to find a suitable floating point accuracy without guessing the decimal value (3 decimals may not be the silver bullet=)
 * split segments at extremes – only useful for manual editing
 * optimize either path data strings or SVG markup code
+* create curves from polylines (curve-fitting)
 
 
 ## TOC
@@ -41,13 +42,15 @@ Unlike most existing approaches (e.g in graphic applications), it checks where s
     - [ESM version](#esm-version)
   + [node.js](#nodejs)
     - [Example 2: Apply options](#example-2-apply-options)
-  + [API](#api)
+  + [Web worker](#web-worker)
+* [API](#api)
   + [Simplification parameters](#simplification-parameters)
   + [Advanced simplifications](#advanced-simplifications)
   + [Output options](#output-options)
   + [SVG scaling](#svg-scaling)
   + [SVG output optimizations](#svg-output-optimizations)
   + [SVG input normalization](#svg-input-normalization)
+* [Lite version](#lite-version--only-path-data)
 * [Demos](#demos)
   + [Web app](#web-app)
   + [Demo files](#demo-files)
@@ -117,7 +120,7 @@ npm install svg-path-simplify
 
 To simplify entire SVG documents in node.js we need to emulate the browsers DOM methods `DOMParser` and `XMLSerializer`. I opted for [linkedom](https://github.com/WebReflection/linkedom). Just make sure to import the `svg-path-simplify/node` module. It will load linkedom's methods `DOMParser` and add a polyfill for `XMLSerializer`
 
-``` 
+```js 
 /**
  * load node polyfills for DOM parsing
  * loads linkedom npm module for DOM parsing and emulation 
@@ -131,10 +134,22 @@ let pathDataString =  `M 57.13 15.5c 13.28 0 24.53 8.67 28.42 20.65c 0.94 2.91 1
 let pathDataOpt = svgPathSimplify(pathDataString);
 ```
 
+### Web worker
+Similar to node.js usage we need [linkedom](https://github.com/WebReflection/linkedom) to polyfill missing DOMParser functionality in a headless environment.
+
+```js
+import './svg-path-simplify.worker.polyfills.js';
+import { svgPathSimplify } from './svg-path-simplify.esm.js';
+```
+
+Import the polyfill module from the dist folder. It imports the worker version of linkedom.
+See [svg-path-simplify.worker.js](https://github.com/herrstrietzel/svg-path-simplify/blob/main/dist/svg-path-simplify.worker.js).  
+
+
 #### Example 2: Apply options  
 The following example would return a detailed object containing the stringified "normalized" pathdata (all absolute and "longhand" command notation). 
 
-``` 
+```js 
 let options = {
  extrapolateDominant: false,
  decimals: 3,
@@ -200,9 +215,9 @@ Z
 
 
 
-### API
+## API
 
-``` 
+```js 
 let options = {}
 let output = svgPathSimplify(input, options);
 ```
@@ -290,6 +305,36 @@ Scaling only indirectly affects file size analogous to rounding. Use it only for
 | stylesToAttributes | consolidates styles and set them to attributes. Also removes invalid attributes (e.g `font-family` for paths) | Boolean | false |
 
 
+## Lite version – only path data
+Since the library aims at a complete toolset it might be an overkill for your needs. 
+For this use case you can opt for the lighter pathdata only version »svg-path-simplify.pathdata.esm.min«.  Minified filesize is ~41 KB / 17 KB gzipped (compared to the full library with ~72/27 KB)
+
+The API is compatible but simply missing some options such as:  
+* polygon smoothing/curve fitting
+* svg processing - only path data is allowed 
+* no scaling 
+* no path direction fixes
+
+```js
+
+
+import { simplifyPathData } from '../dist/svg-path-simplify.pathdata.esm.js'
+
+let pathDataString =
+`
+M 57.13 15.5
+c 13.28 0 24.53 8.67 28.42 20.65
+c 0.94 2.91 1.45 6.01 1.45 9.23
+`
+// try to simplify
+let pathDataOpt = simplifyPathData(pathDataString);
+
+/*
+ or with options let pathDataOpt = simplifyPathData(pathDataString, options);
+*/
+
+```
+
 
 
 ## Demos
@@ -335,6 +380,8 @@ SVGs > 1 MB are most of the time not salvagable. At least if they contain 10K+ o
 
 ## Changelog, Updates and rollback
 ### Changelog
+* 0.3.0 webapp adds support for multi file batch optimizations, web worker support, drawing direction fix option (for fill rules)
+* 0.2.0 added features for polygon curve fitting
 * 0.1.0 fixed node support for complete svg files
 
 ### Rollback