@rnacanvas/draw.svg 3.2.0 → 3.3.0

package/README.md

@@ -106,3 +106,32 @@ innerXML.toString(); // "<circle></circle><text>A</text>"
 // sets the `innerHTML` property of the target SVG element
 innerXML.set('<rect></rect><text>B</text>');
 ```
+
+## `OuterXML`
+
+The `OuterXML` class represents the outer XML of a target SVG element.
+
+The critical difference between the behavior of this class
+and the `outerHTML` property of SVG elements
+is that the `set()` method of this class modifies the target SVG element <b>in place</b>,
+as opposed to replacing the target SVG element with newly created SVG element(s) in the DOM tree,
+which is what setting the `outerHTML` property does.
+
+Thus, the `set()` method will throw if the specified outer XML does not encode exactly one SVG element
+or if the specified outer XML encodes an SVG element with a tag name different from that of the target SVG element.
+
+```javascript
+var svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
+
+svg.setAttribute('viewBox', '0 0 10 20');
+
+svg.append(document.createElementNS('http://www.w3.org/2000/svg', 'circle'));
+svg.append(document.createElementNS('http://www.w3.org/2000/svg', 'rect'));
+svg.append('Some text.');
+
+var outerXML = new OuterXML(svg);
+
+outerXML.toString(); // '<svg viewBox="0 0 10 20"><circle></circle><rect></rect>Some text.</svg>'
+
+outerXML.set('<svg viewBox="0 0 25 25" width="50" height="50>Different text.<path></path></svg>');
+```

package/dist/InnerXML.d.ts

@@ -1,15 +1,15 @@
 /**
- * Represents the inner XML of a target SVG document.
+ * Represents the inner XML of a target SVG element.
  */
 export declare class InnerXML {
     #private;
-    constructor(targetSVGDoc: SVGSVGElement);
+    constructor(targetSVGElement: SVGElement);
     /**
-     * Returns the `innerHTML` property of the target SVG document.
+     * Returns the `innerHTML` property of the target SVG element.
      */
     toString(): string;
     /**
-     * Sets the `innerHTML` property of the target SVG document.
+     * Sets the `innerHTML` property of the target SVG element.
      */
     set(innerXML: string): void;
 }

package/dist/InnerXML.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InnerXML.d.ts","sourceRoot":"","sources":["../src/InnerXML.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,QAAQ;;gBAGP,YAAY,EAAE,aAAa;IAIvC;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAG5B"}
+{"version":3,"file":"InnerXML.d.ts","sourceRoot":"","sources":["../src/InnerXML.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,QAAQ;;gBAGP,gBAAgB,EAAE,UAAU;IAIxC;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAG5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnacanvas/draw.svg",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "SVG drawing utilities",
   "repository": {
     "type": "git",