@d3plus/export 3.0.0-alpha.0

package/README.md

@@ -0,0 +1,44 @@
+# @d3plus/export
+  
+Export methods for transforming and downloading SVG.
+
+## Installing
+
+If using npm, `npm install @d3plus/export`. Otherwise, you can download the [latest release from GitHub](https://github.com/d3plus/d3plus/releases/latest) or load from a [CDN](https://cdn.jsdelivr.net/npm/@d3plus/export@3.0.0-alpha.0/+esm).
+
+```js
+import modules from "@d3plus/export";
+```
+
+In vanilla JavaScript, a `d3plus` global is exported from the pre-bundled version:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@d3plus/export@3.0.0-alpha.0"></script>
+<script>
+  console.log(d3plus);
+</script>
+```
+
+## Examples
+
+Live examples can be found on [d3plus.org](https://d3plus.org/), which includes a collection of example visualizations using @d3plus/react.
+
+## API Reference
+
+##### 
+* [saveElement](#saveElement) - Downloads an HTML Element as a bitmap PNG image.
+
+---
+
+<a name="saveElement"></a>
+#### d3plus.**saveElement**(elem, [options], [renderOptions]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/export/src/saveElement.js#L9)
+
+Downloads an HTML Element as a bitmap PNG image.
+
+
+This is a global function
+
+---
+
+
+###### <sub>Documentation generated on Thu, 13 Mar 2025 19:58:29 GMT</sub>

package/es/index.js

@@ -0,0 +1 @@
+export { default as saveElement } from "./src/saveElement.js";

package/es/src/saveElement.js

@@ -0,0 +1,41 @@
+import { toBlob, toSvg } from "html-to-image";
+import { saveAs } from "file-saver";
+var defaultOptions = {
+    filename: "download",
+    type: "png"
+};
+/**
+    @function saveElement
+    @desc Downloads an HTML Element as a bitmap PNG image.
+    @param {HTMLElement} elem A single element to be saved to one file.
+    @param {Object} [options] Additional options to specify.
+    @param {String} [options.filename = "download"] Filename for the downloaded file, without the extension.
+    @param {String} [options.type = "png"] File type of the saved document. Accepted values are `"png"` and `"jpg"`.
+    @param {Function} [options.callback] Function to be invoked after saving is complete.
+    @param {Object} [renderOptions] Custom options to be passed to the html-to-image function.
+*/ export default function(elem) {
+    var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, renderOptions = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {};
+    if (!elem) return;
+    options = Object.assign({}, defaultOptions, options);
+    // rename renderOptions.background to backgroundColor for backwards compatibility
+    renderOptions = Object.assign({
+        backgroundColor: renderOptions.background
+    }, renderOptions);
+    function finish(blob) {
+        saveAs(blob, "".concat(options.filename, ".").concat(options.type));
+        if (options.callback) options.callback();
+    }
+    if (options.type === "svg") {
+        toSvg(elem, renderOptions).then(function(dataUrl) {
+            var xhr = new XMLHttpRequest();
+            xhr.open("GET", dataUrl);
+            xhr.responseType = "blob";
+            xhr.onload = function() {
+                return finish(xhr.response);
+            };
+            xhr.send();
+        });
+    } else {
+        toBlob(elem, renderOptions).then(finish);
+    }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@d3plus/export",
+  "version": "3.0.0-alpha.0",
+  "description": "Export methods for transforming and downloading SVG.",
+  "license": "MIT",
+  "type": "module",
+  "exports": "./es/index.js",
+  "browser": "./umd/d3plus-export.full.js",
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
+  "files": [
+    "umd",
+    "es"
+  ],
+  "homepage": "https://d3plus.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/d3plus/d3plus.git",
+    "directory": "packages/export"
+  },
+  "keywords": [
+    "export",
+    "d3",
+    "d3plus",
+    "data",
+    "visualization"
+  ],
+  "scripts": {
+    "build:esm": "node ../../scripts/build-esm.js",
+    "build:umd": "node ../../scripts/build-umd.js",
+    "dev": "node ../../scripts/dev.js",
+    "test": "eslint index.js src/**/*.js && eslint --global=it test && mocha 'test/**/*-test.js'"
+  },
+  "dependencies": {
+    "file-saver": "1.3.3",
+    "html-to-image": "^1.11.11"
+  }
+}