@thi.ng/hiccup-svg 5.1.2 → 5.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-19T11:01:47Z
+- **Last updated**: 2023-12-26T14:10:51Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [5.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/hiccup-svg@5.2.0) (2023-12-26)
+
+#### 🚀 Features
+
+- include Inkscape xmlns in `<svg>` root ([997850b](https://github.com/thi-ng/umbrella/commit/997850b))
+- add `__inkscapeLayer` group attrib handling ([79a3932](https://github.com/thi-ng/umbrella/commit/79a3932))
+
 ## [5.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/hiccup-svg@5.1.0) (2023-12-18)
 
 #### 🚀 Features

package/convert.d.ts

@@ -12,6 +12,9 @@
  * conversions). See {@link setPrecision}. Child shapes (of a group) inherit the
  * precision setting of their parent.
  *
+ * Also see {@link group} for handling of the special `__inkscapeLayer` group
+ * attrib.
+ *
  * To control the formatting precision for colors, use [the relevant function in
  * the thi.ng/color
  * package](https://docs.thi.ng/umbrella/color/functions/setPrecision.html).

package/convert.js

@@ -4,6 +4,7 @@ import { circle } from "./circle.js";
 import { ellipse } from "./ellipse.js";
 import { PRECISION, fattribs, setPrecision } from "./format.js";
 import { linearGradient, radialGradient } from "./gradients.js";
+import { __groupLayerID } from "./group.js";
 import { image } from "./image.js";
 import { hline, line, vline } from "./line.js";
 import { path } from "./path.js";
@@ -55,6 +56,8 @@ const convertTree = (tree) => {
     case "a":
     case "g":
       result = [type, fattribs(attribs)];
+      if (tree[0] === "g")
+        __groupLayerID(result[1]);
       for (let i = 2, n = tree.length; i < n; i++) {
         const c = convertTree(tree[i]);
         c != null && result.push(c);

package/group.d.ts

@@ -1,2 +1,15 @@
+/**
+ * Creates a new SVG group element in hiccup format.
+ *
+ * @remarks
+ * If the given attribs contain a `__inkscapeLayer` value (layer name), it will
+ * be auto-converted into the correct set of attributes to define that group as
+ * Inkscape layer.
+ *
+ * @param attribs
+ * @param body
+ */
 export declare const group: (attribs: any, ...body: any[]) => any[];
+/** @internal */
+export declare const __groupLayerID: (attribs: any) => any;
 //# sourceMappingURL=group.d.ts.map

package/group.js

@@ -1,9 +1,18 @@
 import { fattribs } from "./format.js";
 const group = (attribs, ...body) => [
   "g",
-  fattribs({ ...attribs }),
+  __groupLayerID(fattribs({ ...attribs })),
   ...body
 ];
+const __groupLayerID = (attribs) => {
+  if (attribs.__inkscapeLayer) {
+    attribs["inkscape:groupmode"] = "layer";
+    attribs["inkscape:label"] = attribs.__inkscapeLayer;
+    delete attribs.__inkscapeLayer;
+  }
+  return attribs;
+};
 export {
+  __groupLayerID,
   group
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/hiccup-svg",
-  "version": "5.1.2",
+  "version": "5.2.0",
   "description": "SVG element functions for @thi.ng/hiccup & related tooling",
   "type": "module",
   "module": "./index.js",
@@ -37,7 +37,7 @@
   "dependencies": {
     "@thi.ng/checks": "^3.4.14",
     "@thi.ng/color": "^5.6.8",
-    "@thi.ng/prefixes": "^2.2.10"
+    "@thi.ng/prefixes": "^2.3.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.3",
@@ -135,5 +135,5 @@
     "parent": "@thi.ng/hiccup",
     "year": 2016
   },
-  "gitHead": "36d93175f8fbc0190c3c96a9ac0016a9663e9a80\n"
+  "gitHead": "f156d361a652cce316c36e0b7df7d2ac5c2dbbf8\n"
 }

package/svg.d.ts

@@ -1,7 +1,7 @@
 /**
  * Defines an <svg> root element with default XML namespaces. By default
  * currently still defaults to SVG version to 1.1 to support Safari and other
- * legacy tooling.
+ * legacy tooling (can be overridden).
  *
  * @remarks
  * If the `__convert` boolean attrib is enabled, all body elements will be
@@ -9,6 +9,13 @@
  * will be removed afterward and is NOT going to be serialized in the final
  * output.
  *
+ * The root `<svg>` element will contain XML namespace declarations for these
+ * namespaces:
+ *
+ * - [svg (default NS)](https://docs.thi.ng/umbrella/prefixes/variables/XML_SVG.html)
+ * - [`xmlns:inkscape`](https://docs.thi.ng/umbrella/prefixes/variables/XML_INKSCAPE.html)
+ * - [`xmlns:xlink`](https://docs.thi.ng/umbrella/prefixes/variables/XML_XLINK.html)
+ *
  * @param attribs - attributes object
  * @param body - shape primitives
  */

package/svg.js

@@ -1,4 +1,4 @@
-import { XML_SVG, XML_XLINK } from "@thi.ng/prefixes/xml";
+import { XML_INKSCAPE, XML_SVG, XML_XLINK } from "@thi.ng/prefixes/xml";
 import { convertTree } from "./convert.js";
 import { fattribs } from "./format.js";
 const svg = (attribs, ...body) => {
@@ -7,6 +7,7 @@ const svg = (attribs, ...body) => {
       version: "1.1",
       xmlns: XML_SVG,
       "xmlns:xlink": XML_XLINK,
+      "xmlns:inkscape": XML_INKSCAPE,
       ...attribs
     },
     "width",