dom-to-vector-pdf 1.0.2 → 1.1.0

package/LICENSE

@@ -1,21 +1,22 @@
-MIT License
+Copyright
 
 Copyright (c) 2025 xzboss
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,14 @@
+[中文](README.zh-CN.md) ｜ [English](README.md)
+
 # dom-to-vector-pdf
 
 A tool for converting DOM elements to vector PDFs using jsPDF, dom-to-svg and svg2pdf.js.
 
+## Online Demo
+
+[Online Demo](https://dom-to-vector-pdf.xzboss.cn/vue-example)
+[docs](https://dom-to-vector-pdf.xzboss.cn/docs)
+
 ## Installation
 
 ```bash
@@ -14,19 +21,14 @@ npm install dom-to-vector-pdf
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| selector | string | required | CSS selector for DOM element to export |
+| selector | string | required | CSS selector for the DOM element to export |
 | filename | string | required | Exported PDF file name |
-| orientation | 'portrait' \| 'landscape' | 'portrait' | PDF orientation |
-| unit | 'px' | Unit for measurements(only px) |
-| beforeSvgConvert | (svgElement: SVGElement) => void | - | Custom hook for processing SVG elements |
-| beforePdfSave | (pdf: jsPDF) => void | - | Custom hook for processing PDF document |
 
 ### Font Options
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | font | string | required | Font file path or URL |
-| fontId | string | required | Font ID for identifying the font |
 | fontStyle | 'normal' \| 'italic' | 'normal' | Font style |
 | fontWeight | string \| number | - | Font weight (100-900) |
 
@@ -42,19 +44,19 @@ npm install dom-to-vector-pdf
 ## Basic Usage
 
 ```javascript
+import fontTTF from '@/assets/your-font.ttf'
+
 import vectorInstance from "dom-to-vector-pdf";
 
 export const ExportToPDF = (selector, title) => {
   vectorInstance.registerFont([
     {
-      font: PingFangRegular,
-      fontId: "PingFang",
+      font: fontTTF,
       fontWeight: "400",
       fontStyle: "normal",
     },
     {
-      font: PingFangHeavy,
-      fontId: "PingFang",
+      font: fontTTF,
       fontWeight: "700",
       fontStyle: "normal",
     },
@@ -74,42 +76,17 @@ export const ExportToPDF = (selector, title) => {
 - Maintains font styles and weights
 - Handles complex layouts
 
-## Todo List
-
-### DOM Cloning
-- [ ] Inline style handling
-  - [ ] Style priority management
-- [ ] Shadow DOM support
-- [ ] iframe support
-
-### Icon Fonts
-- [ ] Current implementation uses 16px as base font size for scaling
-- [ ] Need to improve icon font size handling
-
-### SVG Support
-- [ ] Currently only supports inline styles where property names match element attributes
-- [ ] Need to enhance SVG style handling
-
-### Text Alignment
-- [ ] Text appears slightly lower than background
-  - Current workaround: Shift all text up by 3 pixels
-
-### Unsupported Features
-- [ ✅  ] Image background export
-- [ ] Canvas export
-- [ ] other unit
-
-### Font Support
-- [ ] Currently limited to single font family
-  - Font ID must be consistent during registration
-- [ ] Need to add support for multiple fonts
-- [ ] Consider WOFF2 format compatibility
-
-### Image Export
-- [ ] Image export quality needs improvement
 
 ## Contributing
 
+### Setup
+```
+pnpm i
+```
+### Run demo
+```
+pnpm dev:vue
+```
 Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## License

package/README.zh-CN.md

@@ -1,7 +1,15 @@
+[中文](README.zh-CN.md) ｜ [English](README.md)
+
 # dom-to-vector-pdf
 
 一个使用 jsPDF、dom-to-svg 和 svg2pdf.js 将 DOM 元素转换为矢量 PDF 的工具。
 
+## 在线示例
+
+[在线演示](https://dom-to-vector-pdf.xzboss.cn/vue-example)
+[docs](https://dom-to-vector-pdf.xzboss.cn/docs)
+
+
 ## 安装
 
 ```bash
@@ -16,17 +24,12 @@ npm install dom-to-vector-pdf
 |------|------|--------|------|
 | selector | string | 必填 | 要导出的DOM元素的CSS选择器 |
 | filename | string | 必填 | 导出的PDF文件名 |
-| orientation | 'portrait' \| 'landscape' | 'portrait' | PDF方向 |
-| unit | 'px' | 测量单位（只支持px） |
-| beforeSvgConvert | (svgElement: SVGElement) => void | - | SVG元素处理钩子 |
-| beforePdfSave | (pdf: jsPDF) => void | - | PDF文档处理钩子 |
 
 ### 字体选项
 
 | 选项 | 类型 | 默认值 | 说明 |
 |------|------|--------|------|
 | font | string | 必填 | 字体文件路径或URL |
-| fontId | string | 必填 | 字体ID |
 | fontStyle | 'normal' \| 'italic' | 'normal' | 字体样式 |
 | fontWeight | string \| number | - | 字体粗细(100-900) |
 
@@ -42,19 +45,19 @@ npm install dom-to-vector-pdf
 ## 基本用法
 
 ```javascript
+import fontTTF from '@/assets/your-font.ttf'
+
 import vectorInstance from "dom-to-vector-pdf";
 
 export const ExportToPDF = (selector, title) => {
   vectorInstance.registerFont([
     {
-      font: PingFangRegular,
-      fontId: "PingFang",
+      font: fontTTF,
       fontWeight: "400",
       fontStyle: "normal",
     },
     {
-      font: PingFangHeavy,
-      fontId: "PingFang",
+      font: fontTTF,
       fontWeight: "700",
       fontStyle: "normal",
     },
@@ -74,44 +77,19 @@ export const ExportToPDF = (selector, title) => {
 - 保持字体样式和粗细
 - 处理复杂布局
 
-## 待办事项
-
-### DOM克隆
-- [ ] 内联样式处理
-  - [ ] 样式优先级管理
-- [ ] Shadow DOM支持
-- [ ] iframe支持
-
-### 图标字体
-- [ ] 当前实现使用16px作为基础字体大小进行缩放
-- [ ] 需要改进图标字体大小处理
-
-### SVG支持
-- [ ] 目前仅支持属性名与元素属性匹配的内联样式
-- [ ] 需要增强SVG样式处理
-
-### 文本对齐
-- [ ] 文本位置略低于背景
-  - 当前解决方案：将所有文本向上偏移3像素
-
-### 不支持的功能
-- [ ✅ ] 图片背景导出
-- [ ] Canvas导出
-- [ ] 其他单位支持
-
-### 字体支持
-- [ ] 目前仅限于单个字体系列
-  - 注册时字体ID必须保持一致
-- [ ] 需要添加多字体支持
-- [ ] 考虑WOFF2格式兼容性
-
-### 图片导出
-- [ ] 图片导出质量需要改进
 
 ## 贡献
 
+### 安装
+```
+pnpm i
+```
+### 运行示例
+```
+pnpm dev:vue
+```
 欢迎贡献！请随时提交Pull Request。
 
 ## 许可证
 
-MIT 
+MIT

package/dist/index.d.ts

@@ -1,23 +1,57 @@
-import type { ExportPdfOptions, FontRegisterOptions, LifecycleHooks } from './types';
-export type { ExportPdfOptions, FontRegisterOptions, LifecycleHooks } from './types';
+import { jsPDF } from 'jspdf';
+
 /**
- * DOM to PDF tool instance
+ * Export PDF配置项
  */
+interface ExportPdfOptions {
+    /** DOM element selector to export */
+    selector: string;
+    /** Exported PDF file name */
+    filename: string;
+    /** PDF orientation, default is portrait */
+    orientation?: 'portrait' | 'landscape';
+    /** Unit, default is px */
+    unit?: 'pt' | 'px' | 'in' | 'mm' | 'cm' | 'ex' | 'em' | 'pc';
+    /** resource load timeout, default is 5000 */
+    resourceTimeout?: number;
+    /** Custom hook for processing SVG elements */
+    beforeSvgConvert?: (svgElement: SVGElement) => void;
+    /** Custom hook for processing PDF document */
+    beforePdfSave?: (pdf: jsPDF) => void;
+}
+/**
+ * Font registration options
+ */
+interface FontRegisterOptions {
+    /** Font file path or URL */
+    font: string;
+    /** Font ID for identifying the font */
+    fontId?: string;
+    /** 字体样式 (normal/italic) */
+    fontStyle?: 'normal' | 'italic';
+    /** Font weight (100-900) */
+    fontWeight?: string | number;
+}
+/**
+ * Lifecycle hooks
+ */
+interface LifecycleHooks {
+    /** Triggered after DOM clone */
+    afterDomClone?: (clonedElement: HTMLElement) => void;
+    /** Triggered before SVG conversion */
+    beforeSvgConvert?: (svgElement: SVGElement) => void;
+    /** Triggered before PDF generation */
+    beforePdfGenerate?: (pdf: jsPDF) => void;
+    /** Triggered before PDF save */
+    beforePdfSave?: (pdf: jsPDF) => void;
+}
+
 declare class DOMToPDF {
-    private converter;
     private fontManager;
     constructor();
-    /**
-     * Export PDF
-     * @param options Export configuration
-     * @param hooks Lifecycle hooks
-     */
     exportPDF(options: ExportPdfOptions, hooks?: LifecycleHooks): Promise<void>;
-    /**
-     * Register font
-     * @param options Font registration options
-     */
     registerFont(options: FontRegisterOptions | FontRegisterOptions[]): void;
 }
-export declare const instance: DOMToPDF;
-export default instance;
+declare const instance: DOMToPDF;
+
+export { ExportPdfOptions, FontRegisterOptions, LifecycleHooks, instance as default, instance };