@vue-pdf-viewer/viewer
Version:
A vue-pdf-viewer component for Vue and Nuxt. Suitable for vue-pdf document.
84 lines (83 loc) • 4.2 kB
TypeScript
import type { PageViewport, PDFPageProxy } from 'pdfjs-dist/types/web/interfaces';
import type { PDFDocumentProxy } from 'pdfjs-dist';
import type { CanvasLoadedCallback, AnnotationEventPayload, HighlightEventPayload, HighlightOptions, MatchValue, TextLayerLoadedEventPayload, TextHighlight, CanvasRenderedEventPayload, VisibleArea } from '../utils/types';
interface BaseProps {
pageIndex: number;
page: PDFPageProxy;
viewport: PageViewport;
document: PDFDocumentProxy;
afterCanvasLoaded?: CanvasLoadedCallback;
annoImageResourcesPath?: string;
visibleArea?: VisibleArea;
}
type TextProps = {
initialTextLayer: boolean;
textLayer: boolean;
searchKeyword?: string;
highlightTexts?: TextHighlight[];
currentHighlight?: MatchValue;
highlightOptions?: HighlightOptions;
};
type OwnProps = BaseProps & TextProps;
declare const _default: {
new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<OwnProps>>> & Readonly<{
onHighlight?: ((payload: HighlightEventPayload) => any) | undefined;
onTextLoaded?: ((payload: TextLayerLoadedEventPayload) => any) | undefined;
onAnnotated?: ((payload: AnnotationEventPayload) => any) | undefined;
onCanvasRendered?: ((payload: CanvasRenderedEventPayload) => any) | undefined;
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
highlight: (payload: HighlightEventPayload) => void;
} & {
textLoaded: (payload: TextLayerLoadedEventPayload) => void;
} & {
annotated: (payload: AnnotationEventPayload) => void;
} & {
canvasRendered: (payload: CanvasRenderedEventPayload) => void;
}, import("vue").PublicProps, {}, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
P: {};
B: {};
D: {};
C: {};
M: {};
Defaults: {};
}, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<OwnProps>>> & Readonly<{
onHighlight?: ((payload: HighlightEventPayload) => any) | undefined;
onTextLoaded?: ((payload: TextLayerLoadedEventPayload) => any) | undefined;
onAnnotated?: ((payload: AnnotationEventPayload) => any) | undefined;
onCanvasRendered?: ((payload: CanvasRenderedEventPayload) => any) | undefined;
}>, {}, {}, {}, {}, {}>;
__isFragment?: undefined;
__isTeleport?: undefined;
__isSuspense?: undefined;
} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<OwnProps>>> & Readonly<{
onHighlight?: ((payload: HighlightEventPayload) => any) | undefined;
onTextLoaded?: ((payload: TextLayerLoadedEventPayload) => any) | undefined;
onAnnotated?: ((payload: AnnotationEventPayload) => any) | undefined;
onCanvasRendered?: ((payload: CanvasRenderedEventPayload) => any) | undefined;
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
highlight: (payload: HighlightEventPayload) => void;
} & {
textLoaded: (payload: TextLayerLoadedEventPayload) => void;
} & {
annotated: (payload: AnnotationEventPayload) => void;
} & {
canvasRendered: (payload: CanvasRenderedEventPayload) => void;
}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
$slots: {
pageOverlay: (_: {
pageIndex: number;
scale: number;
pageElement: HTMLElement | SVGElement | null | undefined;
}) => any;
};
});
export default _default;
type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
type __VLS_TypePropsToRuntimeProps<T> = {
[K in keyof T]-?: {} extends Pick<T, K> ? {
type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
} : {
type: import('vue').PropType<T[K]>;
required: true;
};
};