@vue-pdf-viewer/viewer 1.2.0-rc.0 → 1.3.0-beta.0

package/dist/types/const.d.ts

@@ -1,12 +1,17 @@
+import { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
+import type { PDFPageProxy } from 'pdfjs-dist/types/web/interfaces';
 import type { InjectionKey, Slot, Ref, ComponentPublicInstance, ShallowRef } from 'vue';
-import type { License, Localization, ToolbarOptions, ViewerPdfPage } from './components';
+import { Destination, HighlightMatchPosition, License, Localization, Offset, ToolbarOptions, ViewerPdfPage } from './components';
 export declare const DEFAULT_TOOLBAR_OPTIONS: ToolbarOptions;
 export declare const Locales: Record<string, Localization>;
+export declare const DEFAULT_OFFSET: Offset;
 export declare const PERCENTAGE = 100;
 export declare const MIN_ZOOM_SCALE = 0.25;
 export declare const MAX_ZOOM_SCALE = 10;
 export declare const SCROLL_BAR_WIDTH = 20;
-export declare const PAGE_PADDING = 8;
+export declare const PAGE_PADDING = 1;
+export declare const PAGE_OFFSET = 5;
+export declare const LAST_PAGE_OFFSET = 4;
 export declare const FILE_INPUT: InjectionKey<Ref<ComponentPublicInstance<import("vue").DefineComponent<{}, {
     triggerClick: () => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -44,11 +49,23 @@ export declare const FILE_INPUT: InjectionKey<Ref<ComponentPublicInstance<import
     onChange?: ((file: string) => any) | undefined;
     onFilenameChange?: ((file: string) => any) | undefined;
 }, {}, {}>, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | undefined>>;
+export declare const LATEST_MATCH_POSITION: InjectionKey<Ref<HighlightMatchPosition | undefined, HighlightMatchPosition | undefined>>;
+export declare const GET_PAGE: InjectionKey<(doc: PDFDocumentProxy, pageIndex: number) => Promise<PDFPageProxy>>;
+export declare const VIEWER_STATE: InjectionKey<{
+    pdfDocument: PDFDocumentProxy | undefined;
+    pagesContainerRef: HTMLElement | undefined;
+    pageIndex: number;
+    viewMode: import("./components").ViewMode;
+    scrollMode: import("./components").ScrollMode;
+    scale: number | undefined;
+    rotation: number;
+}>;
+export declare const LATEST_DESTINATION: InjectionKey<Ref<Destination | undefined, Destination | undefined>>;
 export declare const TOOLBAR_OPTIONS: InjectionKey<Ref<ToolbarOptions | undefined, ToolbarOptions | undefined>>;
 export declare const TOTAL_TOOL_OTHERS_MENU: InjectionKey<Ref<number, number>>;
 export declare const IS_DARK: InjectionKey<Ref<boolean, boolean>>;
 export declare const IS_MOBILE_VIEW: InjectionKey<Ref<boolean, boolean>>;
-export declare const PAGES_CONTAINER: InjectionKey<ShallowRef<HTMLDivElement | null>>;
+export declare const PAGES_CONTAINER: InjectionKey<ShallowRef<HTMLDivElement | undefined>>;
 export declare const pdfPagesKey: InjectionKey<ViewerPdfPage[] | null>;
 export declare const FOCUSED_PAGE_NUMBER: InjectionKey<Ref<number, number>>;
 export declare const ROTATION_DEGREE: InjectionKey<Ref<number, number>>;
@@ -62,3 +79,4 @@ export declare const SLOT_ICON_DOWNLOAD: InjectionKey<Slot<any> | undefined>;
 export declare const SLOT_ICON_PRINT: InjectionKey<Slot<any> | undefined>;
 export declare const SLOT_ICON_FULLSCREEN: InjectionKey<Slot<any> | undefined>;
 export declare const LANG: InjectionKey<Ref<Localization, Localization> | undefined>;
+export declare const FUNC_GO_TO_PAGE: InjectionKey<(page: number) => void>;

package/dist/types/utils/enumerators.d.ts

@@ -0,0 +1,35 @@
+export declare enum ScrollMode {
+    Vertical = "Vertical",
+    Horizontal = "Horizontal",
+    Page = "Page",
+    Wrapped = "Wrapped"
+}
+export declare enum ViewMode {
+    SinglePage = "SinglePage",
+    DualPage = "DualPage",
+    DualPageWithCover = "DualPageWithCover"
+}
+export declare enum ZoomLevel {
+    ActualSize = "actualSize",
+    PageFit = "pageFit",
+    PageWidth = "pageWidth"
+}
+export declare enum ScrollDirection {
+    Horizontal = "Horizontal",
+    Vertical = "Vertical",
+    Both = "Both"
+}
+export declare enum VPVAnnotationType {
+    INTERNAL_LINK = "internal-link",
+    LINK = "link",
+    FILE_ATTACHMENT = "file-attachment",
+    FORM_TEXT = "form-text",
+    FORM_SELECT = "form-select",
+    FORM_CHECKBOX = "form-checkbox",
+    FORM_RADIO = "form-radio",
+    FORM_BUTTON = "form-button"
+}
+export declare enum LayerRenderStatus {
+    PreRender = 0,
+    DidRender = 1
+}

package/dist/types/utils/smoothScroll.d.ts

@@ -0,0 +1,2 @@
+import { ScrollDirection, Offset } from '..';
+export declare const smoothScroll: (ele: HTMLElement, scrollDirection: ScrollDirection, targetPosition: Offset, duration: number, easing?: (t: number) => number, onReachTarget?: () => void) => void;

package/dist/types/{components → utils}/types.d.ts

@@ -1,8 +1,8 @@
+import { ExtractPublicPropTypes, MaybeRef, PropType, Ref, ShallowRef } from 'vue';
 import type { PageViewport } from 'pdfjs-dist';
-import type { DocumentInitParameters, OnProgressParameters, PDFDataRangeTransport, TextContent, TypedArray, PDFPageProxy } from 'pdfjs-dist/types/src/display/api';
+import type { DocumentInitParameters, OnProgressParameters, PDFDataRangeTransport, TextContent, TypedArray, PDFPageProxy, PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
 import type { Metadata } from 'pdfjs-dist/types/src/display/metadata';
-import { VPVAnnotationType } from './utils/annotations';
-import { ExtractPublicPropTypes, MaybeRef, PropType } from 'vue';
+import { ZoomLevel, ViewMode, ScrollMode, VPVAnnotationType } from './enumerators';
 export interface Match {
     start: {
         idx: number;
@@ -50,6 +50,7 @@ export interface HighlightEventPayload {
 export interface TextLayerLoadedEventPayload {
     textDivs: HTMLElement[];
     textContent: TextContent | undefined;
+    textLayerRef?: HTMLElement;
 }
 export interface HighlightOptions {
     ignoreCase?: boolean;
@@ -97,35 +98,30 @@ export interface PDFInfo {
     javascript: string[] | null;
     outline: any;
 }
-export interface PageSize {
-    height: number;
-    width: number;
-    rotation: number;
-}
 export interface AppPdfPage {
     page: PDFPageProxy;
     viewport: PageViewport;
     height: number;
     scale: number;
 }
-export interface ViewerPdfPage {
-    page: PDFPageProxy;
-    viewport: PageViewport;
+export interface Rect {
     height: number;
+    width: number;
+}
+export interface PdfPageSize {
+    rotation: number;
+    pageRect: Rect;
 }
 export interface VPVThumbnail {
     page: PDFPageProxy;
 }
-export declare enum ZoomLevel {
-    ActualSize = "actualSize",
-    PageFit = "pageFit",
-    PageWidth = "pageWidth"
-}
 export interface Offset {
     left: number;
     top: number;
 }
-export interface Rect {
+export interface ViewerPdfPage {
+    page: PDFPageProxy;
+    viewport: PageViewport;
     height: number;
     width: number;
 }
@@ -136,14 +132,37 @@ export interface ItemMeasurement {
     end: Offset;
     visibility: number;
 }
+export interface VirtualItem extends ItemMeasurement {
+    pdfPage: ViewerPdfPage;
+}
 export type DestinationOffsetFromViewport = (viewportWidth: number, viewportHeight: number) => number;
 export interface Destination {
+    pageIndex: number;
     bottomOffset: number | DestinationOffsetFromViewport;
-    label?: string;
     leftOffset: number | DestinationOffsetFromViewport;
-    pageIndex: number;
+    label?: string;
     scaleTo?: number | ZoomLevel;
 }
+export interface PageDimensionsWithSummation {
+    pageNumber: number;
+    dimension: {
+        width: number;
+        height: number;
+    };
+    summation: {
+        totalWidth: number;
+        totalHeight: number;
+    };
+}
+export interface ViewerState {
+    pdfDocument: ShallowRef<PDFDocumentProxy | undefined>;
+    pagesContainerRef: ShallowRef<HTMLElement | undefined>;
+    pageIndex: Ref<number>;
+    viewMode: Ref<ViewMode>;
+    scrollMode: Ref<ScrollMode>;
+    scale: Ref<number | undefined>;
+    rotation: Ref<number>;
+}
 export interface ToolbarOptions {
     /**
      * Determines whether the toolbar includes a search functionality.
@@ -209,12 +228,20 @@ export interface ToolbarOptions {
      * Determines whether top page & last page menu are a part of the others dropdown menu.
      */
     jumpNavigatable: boolean;
+    /**
+     * Indicates whether the viewer's scrolling modes can be toggled via the more options dropdown menu.
+     */
+    scrollingSwitchable: boolean;
+    /**
+     * Indicates whether the viewer's page view modes can be toggled via the more options dropdown menu.
+     */
+    pageViewSwitchable: boolean;
 }
 export interface License {
     isValidKey: boolean;
     licenseKey: string | null;
 }
-type VPVSrc = Omit<PDFSrc, 'DocumentInitParameters' | 'PDFDataRangeTransport'>;
+export type VPVSrc = Omit<PDFSrc, 'DocumentInitParameters' | 'PDFDataRangeTransport'>;
 export interface VPdfViewerProps {
     src: MaybeRef<VPVSrc>;
     /**
@@ -230,7 +257,15 @@ export interface VPdfViewerProps {
      * The initial zoom level default
      * If unspecified, the initial zoom level is determined by the page dimensions and the width of the container
      */
-    initialScale?: number;
+    initialScale?: number | ZoomLevel;
+    /**
+     * The initial scroll mode of PDF viewer
+     */
+    initialScrollMode?: ScrollMode;
+    /**
+     * The initial viewer mode
+     */
+    initialViewMode?: ViewMode;
     /**
      * The initial rotation must be divisible by 90
      */
@@ -260,9 +295,17 @@ export interface VPdfViewerProps {
      */
     localization?: Record<string, Localization>;
 }
+export interface HighlightMatchPosition {
+    matchIdx: number;
+    pageIdx: number;
+}
+export interface HighlightMatchPosition {
+    matchIdx: number;
+    pageIdx: number;
+}
 export declare const VPVBaseProps: {
     readonly src: {
-        readonly type: PropType<string | MaybeRef<VPVSrc>>;
+        readonly type: PropType<string | VPVSrc>;
         readonly required: true;
     };
     readonly workerUrl: {
@@ -274,8 +317,18 @@ export declare const VPVBaseProps: {
         readonly default: () => number;
     };
     readonly initialScale: {
-        readonly type: PropType<number>;
-        readonly default: undefined;
+        readonly type: PropType<number | ZoomLevel>;
+        readonly default: () => ZoomLevel;
+    };
+    readonly initialScrollMode: {
+        readonly type: PropType<ScrollMode>;
+        readonly default: () => ScrollMode;
+        readonly validator: (initialScrollMode: ScrollMode, args: unknown) => boolean;
+    };
+    readonly initialViewMode: {
+        readonly type: PropType<ViewMode>;
+        readonly default: () => ViewMode;
+        readonly validator: (initialViewMode: ViewMode, args: unknown) => boolean;
     };
     readonly initialRotation: {
         readonly type: PropType<number>;
@@ -370,4 +423,7 @@ export type Localization = {
     dragDropFileMessage: string;
 };
 export type VPdfViewerBasePropsType = ExtractPublicPropTypes<typeof VPVBaseProps>;
-export {};
+export interface HighlightMatchPosition {
+    matchIdx: number;
+    pageIdx: number;
+}

package/dist/types/utils/validators.d.ts

@@ -0,0 +1,4 @@
+import { ScrollMode, ViewMode } from './enumerators';
+import { VPdfViewerProps } from './types';
+export declare function getValidScrollMode(args: Pick<VPdfViewerProps, 'initialViewMode' | 'initialScrollMode'>, warn?: boolean): ScrollMode;
+export declare function getValidViewMode(args: Pick<VPdfViewerProps, 'initialViewMode' | 'initialScrollMode'>, warn?: boolean): ViewMode;

package/dist/types/utils.d.ts

@@ -1,5 +1,6 @@
 import type { ClassValue } from 'clsx';
 import type { PageViewport } from 'pdfjs-dist';
+import { ViewMode, ZoomLevel } from './utils/enumerators';
 export declare function cn(...inputs: ClassValue[]): string;
 export declare function formatNumber(value?: string): string;
 export declare function formatFileSize(bytes: number, decimalPoint?: number): string;
@@ -10,3 +11,4 @@ export declare const PrintElement: {
     print: (elements: HTMLElement[]) => void;
 };
 export declare const dateFormatter: (date: string) => string;
+export declare function calculateScale(container: HTMLElement, pageHeight: number, pageWidth: number, scale: ZoomLevel, viewMode: ViewMode, numPages: number): number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vue-pdf-viewer/viewer",
   "private": false,
-  "version": "1.2.0-rc.0",
+  "version": "1.3.0-beta.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -88,7 +88,7 @@
     "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-vue": "^9.25.0",
     "happy-dom": "^14.7.1",
-    "husky": "^9.0.11",
+    "husky": "^9.1.4",
     "jest": "^29.7.0",
     "jsdom": "^24.0.0",
     "lint-staged": "^15.2.5",

package/dist/types/composables/useCalculatePages.d.ts

@@ -1,12 +0,0 @@
-import { MaybeRef, ShallowRef, UnwrapNestedRefs } from 'vue';
-import { ViewerPdfPage } from '@/components/types';
-import type { PDFDocumentProxy } from 'pdfjs-dist';
-export interface UseCalculatePagesDto {
-    pdfDocument: ShallowRef<PDFDocumentProxy | undefined>;
-    rootPagesContainer: ShallowRef<HTMLDivElement | null>;
-    scale?: MaybeRef<number>;
-    rotation?: MaybeRef<number>;
-}
-export declare function useCalculatePages(props: UnwrapNestedRefs<UseCalculatePagesDto>): {
-    pdfPages: ShallowRef<ViewerPdfPage[]>;
-};