@shaonq/vue 1.2.1 → 1.2.3

package/lib/index.d.ts

@@ -8,6 +8,7 @@ import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FormItem } from '@arco-design/web-vue';
 import { hiprint } from '@shaonq/hiprint';
+import { jsPDFOptions } from 'jspdf';
 import { MethodOptions } from 'vue';
 import { Modal } from '@arco-design/web-vue';
 import { ModalConfig } from '@arco-design/web-vue';
@@ -221,8 +222,6 @@ declare const _default: {
 };
 export default _default;
 
-export declare const download: (url: string, fileName?: string) => boolean;
-
 /**
  * @param name 下载名称
  * @param element  HTMLElement
@@ -231,24 +230,35 @@ export declare const download: (url: string, fileName?: string) => boolean;
  * @param {string} option.className 例 class = 'one-page-pdf' ,大量打印必填
  * @param {string} option.success  successCallback worker:any => void
  */
+export declare function delay(ms: number): Promise<unknown>;
+
+export declare const download: (url: string, fileName?: string) => boolean;
+
+/**
+ * 将指定 HTML 元素（及其子元素）渲染为 PDF 并下载。
+ *
+ * @param name - 下载的 PDF 文件名（不带扩展名）
+ * @param element - 要转换为 PDF 的 HTML 元素
+ * @param option - 可选配置项：
+ *   - className?: 用于选择多个子元素的选择器类名
+ *   - paddingBuffer?: 分页时忽略的小段高度阈值（单位 mm）
+ *   - margin?: 页面边距（未在代码中使用，但保留兼容性）
+ *   - 其他 jsPDF 支持的选项（如格式、方向等）
+ *
+ * @throws 如果未传入 element，则抛出错误
+ *
+ * 注意事项：
+ * - 使用 htmlToImage 将 HTML 渲染为 Canvas
+ * - 使用 jsPDF 将 Canvas 添加到 PDF 文档
+ * - 默认 A4 格式纵向，可自定义通过 `option.orientation`
+ * - 当内容高度超过一页时会自动分页
+ * - 存在逻辑错误：canvas 的裁剪方式不正确，会导致每一页都显示整个页面的内容
+ */
 export declare function downLoadPdf(name: string, element: HTMLElement, option?: {
-    /** `pdf page margin`: `[top, left, bottom, right]`  */
-    margin?: number[];
-    /** 启用 `worker` */
     className?: string;
-    /** 缩放比例 */
-    scale?: number;
-    /** 横向 `landscape` ,竖向 `portrait` */
-    letterRendering?: 'landscape' | 'portrait';
-    pagebreak?: {
-        mode?: any;
-        before?: any;
-        after?: any;
-        avoid?: any;
-    };
-    html2canvas?: any;
-    jsPDF?: any;
-} & RecordAny): Promise<void>;
+    paddingBuffer?: number;
+    margin?: any;
+} & jsPDFOptions): Promise<void>;
 
 /**
  * 参考文档 1: http://hiprint.io/docs/text
@@ -1618,6 +1628,11 @@ export declare interface OrcTableOption extends RecordAny_2 {
     tableProps?: TableInstance['$props'];
 }
 
+export declare function pAll(tasks: (() => Promise<any>)[], { concurrency, delayTime }?: {
+    concurrency?: number | undefined;
+    delayTime?: number | undefined;
+}): Promise<any[]>;
+
 declare interface Props {
     useErrData?: <T = Record<string, any>>(config: Record<string, any>) => Promise<[boolean, T]>;
 }