@vue-pdf-viewer/viewer 2.4.0-rc.0 → 2.5.0-beta.0

package/dist/types/assets/pdf-annotations/index.d.ts

@@ -0,0 +1,31 @@
+declare const annoImageResourcesPath: string;
+declare const annoImageResources: {
+    annotationNoicon: string;
+    annotationNote: string;
+    annotationPaperclip: string;
+    annotationParagraph: string;
+    annotationPushpin: string;
+    annotationKey: string;
+    annotationInsert: string;
+    annotationHelp: string;
+    annotationComment: string;
+    annotationCheck: string;
+    altTextWarning: string;
+    altTextSpinner: string;
+    altTextDone: string;
+    altTextDisclaimer: string;
+    altTextAdd: string;
+    cursorEditorTextHighlight: string;
+    cursorEditorInk: string;
+    cursorEditorFreeText: string;
+    cursorEditorFreeHighlight: string;
+    editorToolbarDelete: string;
+    loadingIcon: string;
+    messageBarWarning: string;
+    messageBarClosingButton: string;
+    secondaryToolbarButtonDocumentProperties: string;
+    toolbarButtonMenuArrow: string;
+    toolbarButtonEditorHighlight: string;
+};
+export { annoImageResources };
+export default annoImageResourcesPath;

package/dist/types/components/VPdfViewer.vue.d.ts

@@ -84,7 +84,7 @@ declare const _default: {
         onPageChanged?: ((progress: number) => any) | undefined;
     }>, {
         highlightControl: {
-            highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<void>;
+            highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
             clear: () => void;
         };
         printControl: {
@@ -117,7 +117,7 @@ declare const _default: {
             };
             searching: boolean;
             goToMatch: (index: number) => void;
-            search: (value: string) => void;
+            search: (value: string) => Promise<import("@/utils/types").MatchHighlightResult[]>;
             nextSearchMatch: () => void;
             prevSearchMatch: () => void;
         };
@@ -262,7 +262,7 @@ declare const _default: {
         onPageChanged?: ((progress: number) => any) | undefined;
     }>, {
         highlightControl: {
-            highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<void>;
+            highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
             clear: () => void;
         };
         printControl: {
@@ -295,7 +295,7 @@ declare const _default: {
             };
             searching: boolean;
             goToMatch: (index: number) => void;
-            search: (value: string) => void;
+            search: (value: string) => Promise<import("@/utils/types").MatchHighlightResult[]>;
             nextSearchMatch: () => void;
             prevSearchMatch: () => void;
         };
@@ -415,7 +415,7 @@ declare const _default: {
     onPageChanged?: ((progress: number) => any) | undefined;
 }>, {
     highlightControl: {
-        highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<void>;
+        highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
         clear: () => void;
     };
     printControl: {
@@ -448,7 +448,7 @@ declare const _default: {
         };
         searching: boolean;
         goToMatch: (index: number) => void;
-        search: (value: string) => void;
+        search: (value: string) => Promise<import("@/utils/types").MatchHighlightResult[]>;
         nextSearchMatch: () => void;
         prevSearchMatch: () => void;
     };

package/dist/types/components/ui/popover/PopoverContent.vue.d.ts

@@ -9,7 +9,7 @@ declare const _default: {
         sideOffset: number;
     }>>> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
         sideOffset: number;
-        align: "end" | "center" | "start";
+        align: "start" | "end" | "center";
     }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
         P: {};
         B: {};
@@ -25,7 +25,7 @@ declare const _default: {
         sideOffset: number;
     }>>> & Readonly<{}>, {}, {}, {}, {}, {
         sideOffset: number;
-        align: "end" | "center" | "start";
+        align: "start" | "end" | "center";
     }>;
     __isFragment?: undefined;
     __isTeleport?: undefined;
@@ -38,7 +38,7 @@ declare const _default: {
     sideOffset: number;
 }>>> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
     sideOffset: number;
-    align: "end" | "center" | "start";
+    align: "start" | "end" | "center";
 }, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
     $slots: {
         default: (_: {}) => any;

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

@@ -1,9 +1,9 @@
 import { Ref, ShallowRef } from 'vue';
-import { TextHighlight, MatchHighlight } from '@/components';
+import { TextHighlight, MatchHighlightResult } from '@/components';
 import type { PDFDocumentProxy } from 'pdfjs-dist';
 export interface UseHighlight {
-    highlight: (args: TextHighlight[]) => Promise<void>;
-    highlightMatches: Ref<MatchHighlight[]>;
+    highlight: (args: TextHighlight[]) => Promise<Record<string, MatchHighlightResult[]>>;
+    highlightMatches: Ref<Record<string, MatchHighlightResult[]>>;
     highlightKeywords: Ref<TextHighlight[] | undefined>;
     clear: () => void;
 }

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

@@ -1,5 +1,5 @@
 import { ShallowRef } from 'vue';
 import type { PDFDocumentProxy } from 'pdfjs-dist';
-import { SearchControlValue, HighlightOptions } from '@/components';
+import type { SearchControlValue, HighlightOptions } from '@/utils/types';
 declare const useSearch: (pdfDoc: ShallowRef<PDFDocumentProxy | undefined>, initialSearch?: string, options?: ShallowRef<HighlightOptions>) => SearchControlValue;
 export default useSearch;

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

@@ -1,5 +1,5 @@
 import { ComputedRef, CSSProperties, Ref, StyleValue, UnwrapRef } from 'vue';
-import type { ViewerPdfPage, VirtualRange } from '@/utils/types';
+import type { ViewerPdfPage, VirtualRange, ElementRect } from '@/utils/types';
 import { ScrollMode, ViewMode } from '@/utils/enumerators';
 interface UseVirtualListItem<T> {
     data: T;
@@ -7,7 +7,7 @@ interface UseVirtualListItem<T> {
 }
 export interface UseVirtualListReturn {
     list: Ref<UseVirtualListItem<ViewerPdfPage>[]>;
-    scrollTo: (index: number, rect?: [number, number, number, number]) => void;
+    scrollTo: (index: number, rect?: ElementRect) => void;
     pageGroups: ComputedRef<Array<UseVirtualListItem<ViewerPdfPage>[]> | undefined>;
     containerProps: {
         ref: Ref<HTMLElement | null>;

package/dist/types/const.d.ts

@@ -1,6 +1,6 @@
 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, ComputedRef } from 'vue';
+import type { InjectionKey, Slot, Ref, ComponentPublicInstance, ShallowRef, Reactive, ComputedRef } from 'vue';
 import type { HighlightMatchPosition, HighlightOptions, Localization, NormalizedKeyword, Offset, PdfProperties, ToolbarOptions, ViewerPdfPage, Comment } from './utils/types';
 import { LicenseType, ScrollMode, ViewMode, ZoomLevel } from './components';
 export declare const DEFAULT_TOOLBAR_OPTIONS: ToolbarOptions;
@@ -28,6 +28,7 @@ export declare const SCROLL_BAR_WIDTH = 20;
 export declare const PAGE_PADDING = 1;
 export declare const PAGE_OFFSET = 0;
 export declare const LAST_PAGE_OFFSET = 4;
+export declare const SEARCH_MAX_HEIGHT = 97;
 export declare const FILE_INPUT: InjectionKey<Ref<ComponentPublicInstance<import("vue").DefineComponent<{}, {
     triggerClick: () => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -102,3 +103,4 @@ export declare const PDF_COMMENTS: InjectionKey<{
     comments: Map<number, Comment[]>;
     repliedCommentPages: import("./components").PdfCommentPage[];
 }>;
+export declare const ANNOTATION_CANVAS_MAP: InjectionKey<Reactive<Map<string, HTMLCanvasElement>>>;

package/dist/types/index.d.ts

@@ -3,5 +3,5 @@ import { Locales } from './const';
 export declare const VPdfViewerPlugin: Plugin;
 export { Locales };
 export * from './components';
-export type { VPVInstance, CanvasLoadedCallback, Localization, PrintControl, ToolbarOptions } from './utils/types';
+export type { VPVInstance, CanvasLoadedCallback, Localization, PrintControl, ToolbarOptions, MatchHighlightResult } from './utils/types';
 export default VPdfViewerPlugin;

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

@@ -7,6 +7,12 @@ export interface VirtualRange {
     start: number;
     end: number;
 }
+export interface ElementRect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
 export interface Match {
     start: {
         idx: number;
@@ -19,6 +25,7 @@ export interface Match {
     str: string;
     oIndex: number;
     pageIndex: number;
+    rect: ElementRect;
 }
 export type LoadedEventPayload = number;
 export type FocusedPageEventPayload = number;
@@ -619,6 +626,16 @@ export interface MatchHighlight extends MatchValue {
     keyword: string | RegExp;
     color: string;
 }
+export interface MatchHighlightResult {
+    /**
+     * The index of the page that contains the match
+     */
+    pageIndex: number;
+    /**
+     * The index of the match in the page
+     */
+    pageMatchIdx: number;
+}
 export interface SearchControlValue {
     textContentPages: Ref<Record<string, TextContent>>;
     searchValue: Ref<string | undefined>;
@@ -632,7 +649,7 @@ export interface SearchControlValue {
     onCloseSearch: () => void;
     handleSelectNext: () => void;
     handleSelectPrev: () => void;
-    search: (value: string) => void;
+    search: (value: string) => Promise<MatchHighlightResult[]>;
     goToMatch: (index: number) => void;
 }
 export interface SearchControl {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vue-pdf-viewer/viewer",
   "private": false,
-  "version": "2.4.0-rc.0",
+  "version": "2.5.0-beta.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",