@orca-fe/pdf-viewer/lib/PDFViewer.d.ts

PDF Viewer

import React from 'react';
import type { DocumentInitParameters } from '@orca-fe/pdfjs-dist-browserify/types/src/display/api';
import type { PDFViewerHandle, RenderPageCoverFnType } from './context';
import type { LocaleType } from './locale/context';
export interface PDFViewerProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
    /** 默认缩放级别 */
    defaultZoom?: number | 'autoWidth' | 'autoHeight';
    /** 默认文件标题（非受控） */
    defaultTitle?: React.ReactNode;
    /** 文件标题（受控） */
    title?: React.ReactNode;
    /** 页面之间的间距 */
    pageGap?: number;
    /** 最大缩放级别 */
    maxZoom?: number;
    /** 最小缩放级别 */
    minZoom?: number;
    /** 页面滚动事件 */
    onPageScroll?: React.UIEventHandler<HTMLDivElement>;
    /** 页面变化事件 */
    onPageChange?: (page: number) => void;
    /** 渲染自定义页面覆盖物 */
    renderPageCover?: RenderPageCoverFnType;
    /** 空文件提示 */
    emptyTips?: React.ReactElement;
    /** 自定义加载过程提示 */
    loadingTips?: React.ReactElement;
    /** 隐藏工具栏 */
    hideToolbar?: boolean;
    /** 缩放事件 */
    onZoomChange?: (zoom: number) => void;
    /** 是否支持拖拽打开文件 */
    dropFile?: boolean;
    /** 是否一次性渲染所有的 PDF 页面 */
    renderAllPages?: boolean;
    /** 在项目中使用的 pdf.worker.min.js 路径，默认放在 public 目录下的 /pdf.worker.min.js，版本 3.8.24 */
    workerSrc?: string;
    pdfJsParams?: DocumentInitParameters;
    locale?: LocaleType;
    outputScale?: number;
}
declare const PDFViewer: React.ForwardRefExoticComponent<PDFViewerProps & React.RefAttributes<PDFViewerHandle>>;
export declare const usePdfViewerRef: () => React.RefObject<PDFViewerHandle>;
export default PDFViewer;