zy-react-library 2.2.2 → 2.2.4

package/components/Pdf/index.d.ts

@@ -1,24 +1,26 @@
-import type { CSSProperties, FC, ReactNode } from "react";
-
-export interface PdfProps {
-  /** pdf 文件地址 */
-  file: string;
-  /** pdf 文件名 */
-  name?: string;
-  /** 是否显示弹窗 */
-  visible?: boolean;
-  /** 弹窗的标题，默认 ”PDF预览“ */
-  title?: string;
-  /** 关闭弹窗的方法 */
-  onCancel?: () => void;
-  /** 是否使用内联模式，true为不使用弹窗，默认 false */
-  inline?: boolean;
-  /** 内联模式下的样式 */
-  style?: CSSProperties;
-  /** 弹窗底部额外的按钮 */
-  extraButtons?: ReactNode;
-}
-
-declare const Pdf: FC<PdfProps>;
-
-export default Pdf;
+import type { CSSProperties, FC, ReactNode } from "react";
+
+export interface PdfProps {
+  /** pdf 文件地址 */
+  file: string;
+  /** pdf 文件名 */
+  name?: string;
+  /** 是否显示弹窗 */
+  visible?: boolean;
+  /** 弹窗的标题，默认 ”PDF预览“ */
+  title?: string;
+  /** 关闭弹窗的方法 */
+  onCancel?: () => void;
+  /** 是否使用内联模式，true为不使用弹窗，默认 false */
+  inline?: boolean;
+  /** 内联模式下的样式 */
+  style?: CSSProperties;
+  /** 弹窗底部额外的按钮 */
+  extraButtons?: ReactNode;
+  /** 是否使用打印功能，默认 false */
+  usePrint?: boolean;
+}
+
+declare const Pdf: FC<PdfProps>;
+
+export default Pdf;

package/components/Pdf/index.js

@@ -1 +1 @@
-import{useFullscreen as e}from"ahooks";import{Modal as r,Button as o,Spin as i,message as n}from"antd";import{useState as t,useRef as l}from"react";import{pdfjs as a,Document as d,Page as s}from"react-pdf";import c from"../../hooks/useDownloadFile/index.js";import{getFileUrl as p}from"../../utils/index.js";import"react-pdf/dist/Page/AnnotationLayer.css";import"react-pdf/dist/Page/TextLayer.css";import"./index.less";import{jsx as m,Fragment as f}from"react/jsx-runtime";function h(h){const{visible:u=!1,onCancel:x,file:g,name:v,inline:y=!1,title:w="PDF预览",style:k={},extraButtons:C}=h,j=p(),[F,P]=t(0),[b,L]=t(600),S=l(null),[D,{enterFullscreen:A,exitFullscreen:B}]=e(S),{downloadFile:N}=c();a.GlobalWorkerOptions.workerSrc=`//unpkg.com/pdfjs-dist@${a.version}/build/pdf.worker.min.mjs`;const W=({numPages:e})=>{P(e)},$=()=>{n.error("加载 PDF 文件失败"),x&&x()},z=({width:e})=>{L(e)},E=()=>m(f,{children:m("div",{style:{height:D?"calc(100vh - 40px - 24px - 8px - 32px - 12px)":"72vh",overflowY:"auto",padding:"24px",...k},children:m(d,{file:g.includes(j)?g:j+g,onLoadSuccess:W,onLoadError:$,loading:m("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"65vh"},children:m(i,{size:"large"})}),children:Array.from({length:F}).map((e,r)=>m(s,{pageNumber:r+1,onLoadSuccess:z},`page_${r+1}`))})})});return y?E():m("div",{ref:S,children:m(r,{style:{top:D?0:100,maxWidth:D?"100vw":"calc(100vw - 32px)",paddingBottom:D?0:24},open:u,mask:{closable:!1},width:D?"100vw":b+100,title:w,onCancel:()=>{D&&B(),x()},getContainer:!1,footer:[m(o,{onClick:()=>{D&&B(),x()},children:"关闭"},"cancel"),m(o,{onClick:()=>{D?B():A()},children:D?"退出全屏":"全屏"},"fullScreen"),m(o,{type:"primary",onClick:()=>{D&&B(),N({url:g,name:v})},children:"下载"},"download"),...C||[]],children:E()})})}h.displayName="Pdf";export{h as default};
+import{useFullscreen as e}from"ahooks";import{Modal as t,Button as r,Spin as o,message as n}from"antd";import{useState as i,useRef as l}from"react";import{pdfjs as c,Document as a,Page as s}from"react-pdf";import d from"../../hooks/useDownloadFile/index.js";import{getFileUrl as p}from"../../utils/index.js";import"react-pdf/dist/Page/AnnotationLayer.css";import"react-pdf/dist/Page/TextLayer.css";import"./index.less";import{jsx as m,Fragment as f}from"react/jsx-runtime";function h(h){const{visible:u=!1,onCancel:x,file:g,name:w,inline:y=!1,title:v="PDF预览",style:k={},extraButtons:b,usePrint:L=!1}=h,C=p(),j=g.includes(C)?g:C+g,[P,F]=i(0),[D,R]=i(600),S=l(null),[U,{enterFullscreen:E,exitFullscreen:O}]=e(S),{downloadFile:W}=d();c.GlobalWorkerOptions.workerSrc=`//unpkg.com/pdfjs-dist@${c.version}/build/pdf.worker.min.mjs`;const A=({numPages:e})=>{F(e)},B=()=>{n.error("加载 PDF 文件失败"),x&&x()},N=({width:e})=>{R(e)},T=()=>m(f,{children:m("div",{style:{height:U?"calc(100vh - 40px - 24px - 8px - 32px - 12px)":"72vh",overflowY:"auto",padding:"24px",...k},children:m(a,{file:j,onLoadSuccess:A,onLoadError:B,loading:m("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"65vh"},children:m(o,{size:"large"})}),children:Array.from({length:P}).map((e,t)=>m(s,{pageNumber:t+1,onLoadSuccess:N},`page_${t+1}`))})})});return y?T():m("div",{ref:S,children:m(t,{style:{top:U?0:100,maxWidth:U?"100vw":"calc(100vw - 32px)",paddingBottom:U?0:24},open:u,mask:{closable:!1},width:U?"100vw":D+100,title:v,onCancel:()=>{U&&O(),x()},getContainer:!1,footer:[m(r,{onClick:()=>{U&&O(),x()},children:"关闭"},"cancel"),m(r,{onClick:()=>{U?O():E()},children:U?"退出全屏":"全屏"},"fullScreen"),m(r,{type:"primary",onClick:()=>{U&&O(),W({url:g,name:w})},children:"下载"},"download"),L&&m(r,{type:"primary",onClick:async()=>{const e=window.open("","_blank");if(e)try{const t=await fetch(j);if(!t.ok)return void n.error("获取 PDF 文件失败");const r=URL.createObjectURL(await t.blob()),o=e.document.createElement("iframe");o.style.cssText="position:fixed;inset:0;width:100%;height:100%;border:0",o.onload=()=>{const t=o.contentWindow;t.addEventListener("afterprint",()=>{URL.revokeObjectURL(r),e.close()},{once:!0}),t.focus(),t.print()},o.src=r,e.document.body.appendChild(o)}catch(t){e.close(),n.error(t.message||"打印失败，请稍后重试")}else n.warning("请允许弹出窗口后重试")},children:"打印"},"print"),...b||[]],children:T()})})}h.displayName="Pdf";export{h as default};

package/hooks/useDownloadBlob/index.d.ts

@@ -1,16 +1,45 @@
-interface UseDownloadBlobOptions {
-  /** 下载文件的自定义文件名（不含后缀），默认为当前时间戳 */
-  name?: string;
-  /** Blob 对象的 MIME 类型，默认为 Excel 类型 */
-  type?: string;
-  /** 请求时携带的查询参数对象 */
-  params?: Record<string, any>;
-}
-
-export type DownloadBlobFunction = (url: string, options?: UseDownloadBlobOptions) => Promise<{ data: Blob }>;
-
-/**
- * 下载Blob流文件
- */
-export default function useDownloadBlob(returnType: "array"): [boolean, DownloadBlobFunction];
-export default function useDownloadBlob(returnType?: "object"): { loading: boolean; downloadBlob: DownloadBlobFunction };
+/** 常见下载文件 MIME 类型，同时允许传入其他合法 MIME 字符串 */
+export type DownloadBlobMimeType
+  = | "application/pdf"
+    | "application/msword"
+    | "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+    | "application/vnd.ms-excel"
+    | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+    | "application/vnd.ms-powerpoint"
+    | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
+    | "text/csv"
+    | "text/plain"
+    | "application/json"
+    | "application/zip"
+    | "application/x-rar-compressed"
+    | "application/x-7z-compressed"
+    | "application/gzip"
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/svg+xml"
+    | "image/bmp"
+    | "audio/mpeg"
+    | "audio/wav"
+    | "video/mp4"
+    | "video/webm"
+    | "application/octet-stream"
+    | (string & {});
+
+interface UseDownloadBlobOptions {
+  /** 下载文件的自定义文件名（不含后缀），默认为当前时间戳 */
+  name?: string;
+  /** Blob 对象的 MIME 类型，默认为 application/vnd.ms-excel 类型 */
+  type?: DownloadBlobMimeType;
+  /** 请求时携带的查询参数对象 */
+  params?: Record<string, any>;
+}
+
+export type DownloadBlobFunction = (url: string, options?: UseDownloadBlobOptions) => Promise<{ data: Blob }>;
+
+/**
+ * 下载Blob流文件
+ */
+export default function useDownloadBlob(returnType: "array"): [boolean, DownloadBlobFunction];
+export default function useDownloadBlob(returnType?: "object"): { loading: boolean; downloadBlob: DownloadBlobFunction };

package/hooks/useUrlQueryCriteria/index.d.ts

@@ -1,6 +1,18 @@
 export type SetUrlCriteriaQueryFunction = (searchForm: Record<string, any>, pagination: Record<string, any>) => void;
 
-export type GetUrlCriteriaQueryFunction = (keysStr: "searchFormKeys" | "paginationKeys" | string, valuesStr: "searchFormValues" | "paginationValues" | string) => Record<string, any>;
+/** URL 中存储字段名列表的参数名，同时允许传入自定义参数名 */
+export type UrlCriteriaKeysKey
+  = | "searchFormKeys"
+    | "paginationKeys"
+    | (string & {});
+
+/** URL 中存储字段值列表的参数名，同时允许传入自定义参数名 */
+export type UrlCriteriaValuesKey
+  = | "searchFormValues"
+    | "paginationValues"
+    | (string & {});
+
+export type GetUrlCriteriaQueryFunction = (keysStr: UrlCriteriaKeysKey, valuesStr: UrlCriteriaValuesKey) => Record<string, any>;
 
 /**
  * 处理搜索条件缓存到 URL

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zy-react-library",
   "private": false,
-  "version": "2.2.2",
+  "version": "2.2.4",
   "type": "module",
   "description": "",
   "author": "LiuJiaNan",