@dazhicheng/ui 1.5.149 → 1.5.150

package/dist/hooks/useScreenshotOss.d.ts

@@ -0,0 +1,37 @@
+import { Component, VNode, MaybeRefOrGetter } from 'vue';
+import { ComponentCaptureOptions, ElementScreenshotOptions, ScreenshotTarget } from '../../../hooks/src';
+import { OssSignatureResult } from '../components/tt-upload/src/typing';
+export interface ScreenshotOssOptions extends ElementScreenshotOptions {
+    /** OSS 目录前缀，不传则使用签名接口返回的 dir 或 notice */
+    ossDir?: string;
+    /** 上传文件名，默认 screenshot-{timestamp}.png / .jpg */
+    fileName?: string;
+    /** 获取 OSS 签名，不传则使用全局 setup 的 uploadOssApi */
+    uploadOssApi?: (file: File) => Promise<OssSignatureResult>;
+}
+export interface ScreenshotOssResult {
+    blob: Blob;
+    file: File;
+    ossKey: string;
+}
+export interface ScreenshotOssDataUrlResult extends ScreenshotOssResult {
+    dataUrl: string;
+}
+/** 离屏组件截图 + OSS 上传配置 */
+export type ScreenshotOssComponentOptions = ScreenshotOssOptions & ComponentCaptureOptions;
+/**
+ * @description 元素截图并上传 OSS，依赖全局 setup 的 uploadOssApi
+ */
+export declare function useScreenshotOss(): {
+    captureToBlob: (target: MaybeRefOrGetter<ScreenshotTarget>, options?: ScreenshotOssOptions) => Promise<ScreenshotOssResult>;
+    captureToDataUrl: (target: MaybeRefOrGetter<ScreenshotTarget>, options?: ScreenshotOssOptions) => Promise<ScreenshotOssDataUrlResult>;
+    captureComponent: {
+        (component: Component | VNode, options: ScreenshotOssComponentOptions & {
+            output?: "dataUrl";
+        }): Promise<ScreenshotOssDataUrlResult>;
+        (component: Component | VNode, options: ScreenshotOssComponentOptions & {
+            output: "blob";
+        }): Promise<ScreenshotOssResult>;
+    };
+    isCapturing: import('vue').Ref<boolean, boolean>;
+};