Merge pull request #201 from graphieros/ft-jspdf-as-peer-dep

Ft jspdf as peer dep

Author: graphieros

README.md

@@ -951,3 +951,7 @@ const textContent = createTSpans({
   v-html="textContent"
 />
 ```
+
+## PDF generation
+
+This package requires jspdf as a peer dependency. Please install it in your project if you intend on using the PDF printing feature.

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "vue-data-ui",
   "private": false,
-  "version": "2.8.1",
+  "version": "2.8.2-beta.0",
   "type": "module",
   "description": "A user-empowering data visualization Vue 3 components library for eloquent data storytelling",
   "keywords": [
@@ -92,12 +92,17 @@
     "preprod": "node del-dev-dep.cjs && npm run clean && vite build --mode production && node copy-types.cjs && node copy-docs.cjs && node post-build.cjs"
   },
   "peerDependencies": {
-    "vue": ">=3.3.0"
+    "vue": ">=3.3.0",
+    "jspdf": "^3.0.1"
+  },
+  "peerDependenciesMeta": {
+    "jspdf": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.2.3",
     "cypress": "^14.0.3",
-    "jspdf": "^3.0.1",
     "remove-attr": "^0.0.13",
     "sass": "^1.57.1",
     "simple-git": "^3.24.0",

package.json

@@ -1172,7 +1172,6 @@
 import { opacity, treeShake, convertConfigColors } from "../lib";
 import { useConfig } from "../useConfig";
 import { domToPng } from "../dom-to-png";
-import JsPDF from "jspdf";
 
 // TODO: add tooltips for all buttons
 
@@ -2852,6 +2851,13 @@ export default {
         });
 
         try {
+          let JsPDF;
+          try {
+            JsPDF = (await import("jspdf")).default;
+          } catch (e) {
+            throw new Error("jspdf is not installed.");
+          }
+
           const pngDataUrl = await domToPng({
             container: wrapper,
             scale: 2,

src/components/vue-ui-annotator.vue

@@ -1,9 +1,16 @@
-import JsPDF from "jspdf";
 import { domToPng } from "./dom-to-png"; 
 
 export default async function pdf({ domElement, fileName, scale = 2, options = {} }) {
     if (!domElement) return Promise.reject("No domElement provided");
 
+    let JsPDF;
+
+    try {
+        JsPDF = (await import('jspdf')).default;
+    } catch (e) {
+        return Promise.reject('jspdf is not installed.')
+    }
+
     const a4 = {
         width: 595.28,
         height: 841.89,

src/pdf.js

@@ -212,7 +212,7 @@ declare module "vue-data-ui" {
             table?: string;
             tooltip?: string;
         };
-        // html2canvas options
+        // old html2canvas options
         print?: {
             allowTaint?: boolean;
             backgroundColor?: string;

types/vue-data-ui.d.ts

@@ -36,7 +36,7 @@ export default defineConfig({
     rollupOptions: {
       // make sure to externalize deps that shouldn't be bundled
       // into your library
-      external: ["vue", "vue-data-ui"],
+      external: ["vue", "vue-data-ui", "jspdf"],
       output: {
         // Provide global variables to use in the UMD build
         // for externalized deps