@vue-pdf-viewer/viewer 3.6.0-beta.1 → 3.6.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{index-DooVAB0_.js → index-BGeJV6wk.js} +8759 -8709
- package/dist/{index-BSh5tMMZ.js → index-CfSZh9XR.js} +1 -1
- package/dist/index.js +2 -2
- package/dist/index.umd.cjs +34 -34
- package/dist/types/components/VPdfViewer.vue.d.ts +62 -12
- package/dist/types/utils/types.d.ts +20 -2
- package/dist/types/utils/validators.d.ts +5 -2
- package/package.json +1 -1
|
@@ -20,15 +20,25 @@ declare const _default: {
|
|
|
20
20
|
readonly type: import("vue").PropType<number | ZoomLevel>;
|
|
21
21
|
readonly default: () => ZoomLevel;
|
|
22
22
|
};
|
|
23
|
+
readonly scrollMode: {
|
|
24
|
+
readonly type: import("vue").PropType<ScrollMode>;
|
|
25
|
+
readonly default: () => ScrollMode;
|
|
26
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
27
|
+
};
|
|
28
|
+
readonly viewMode: {
|
|
29
|
+
readonly type: import("vue").PropType<ViewMode>;
|
|
30
|
+
readonly default: () => ViewMode;
|
|
31
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
32
|
+
};
|
|
23
33
|
readonly initialScrollMode: {
|
|
24
34
|
readonly type: import("vue").PropType<ScrollMode>;
|
|
25
35
|
readonly default: () => ScrollMode;
|
|
26
|
-
readonly validator: (
|
|
36
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
27
37
|
};
|
|
28
38
|
readonly initialViewMode: {
|
|
29
39
|
readonly type: import("vue").PropType<ViewMode>;
|
|
30
40
|
readonly default: () => ViewMode;
|
|
31
|
-
readonly validator: (
|
|
41
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
32
42
|
};
|
|
33
43
|
readonly initialRotation: {
|
|
34
44
|
readonly type: import("vue").PropType<number>;
|
|
@@ -92,6 +102,8 @@ declare const _default: {
|
|
|
92
102
|
onLoadProgress?: ((progress: number) => any) | undefined;
|
|
93
103
|
onAfterGoToPage?: ((progress: number) => any) | undefined;
|
|
94
104
|
onPageChanged?: ((progress: number) => any) | undefined;
|
|
105
|
+
"onUpdate:scrollMode"?: ((scrollMode: ScrollMode) => any) | undefined;
|
|
106
|
+
"onUpdate:viewMode"?: ((viewMode: ViewMode) => any) | undefined;
|
|
95
107
|
}>, {
|
|
96
108
|
highlightControl: {
|
|
97
109
|
highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
|
|
@@ -173,16 +185,22 @@ declare const _default: {
|
|
|
173
185
|
rotate: (rotateEvent: RotateEvent) => void;
|
|
174
186
|
} & {
|
|
175
187
|
scroll: (scrollEvent: Event) => void;
|
|
188
|
+
} & {
|
|
189
|
+
"update:scrollMode": (scrollMode: ScrollMode) => void;
|
|
190
|
+
} & {
|
|
191
|
+
"update:viewMode": (viewMode: ViewMode) => void;
|
|
176
192
|
} & {
|
|
177
193
|
afterGoToPage: (progress: number) => void;
|
|
178
194
|
} & {
|
|
179
195
|
pageChanged: (progress: number) => void;
|
|
180
196
|
}, import("vue").PublicProps, {
|
|
181
|
-
readonly
|
|
182
|
-
readonly
|
|
197
|
+
readonly scrollMode: ScrollMode;
|
|
198
|
+
readonly viewMode: ViewMode;
|
|
183
199
|
readonly workerUrl: string;
|
|
184
200
|
readonly initialPage: number;
|
|
185
201
|
readonly initialScale: number | ZoomLevel;
|
|
202
|
+
readonly initialScrollMode: ScrollMode;
|
|
203
|
+
readonly initialViewMode: ViewMode;
|
|
186
204
|
readonly initialRotation: number;
|
|
187
205
|
readonly initialThumbnailsVisible: boolean;
|
|
188
206
|
readonly initialSearch: string;
|
|
@@ -219,15 +237,25 @@ declare const _default: {
|
|
|
219
237
|
readonly type: import("vue").PropType<number | ZoomLevel>;
|
|
220
238
|
readonly default: () => ZoomLevel;
|
|
221
239
|
};
|
|
240
|
+
readonly scrollMode: {
|
|
241
|
+
readonly type: import("vue").PropType<ScrollMode>;
|
|
242
|
+
readonly default: () => ScrollMode;
|
|
243
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
244
|
+
};
|
|
245
|
+
readonly viewMode: {
|
|
246
|
+
readonly type: import("vue").PropType<ViewMode>;
|
|
247
|
+
readonly default: () => ViewMode;
|
|
248
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
249
|
+
};
|
|
222
250
|
readonly initialScrollMode: {
|
|
223
251
|
readonly type: import("vue").PropType<ScrollMode>;
|
|
224
252
|
readonly default: () => ScrollMode;
|
|
225
|
-
readonly validator: (
|
|
253
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
226
254
|
};
|
|
227
255
|
readonly initialViewMode: {
|
|
228
256
|
readonly type: import("vue").PropType<ViewMode>;
|
|
229
257
|
readonly default: () => ViewMode;
|
|
230
|
-
readonly validator: (
|
|
258
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
231
259
|
};
|
|
232
260
|
readonly initialRotation: {
|
|
233
261
|
readonly type: import("vue").PropType<number>;
|
|
@@ -291,6 +319,8 @@ declare const _default: {
|
|
|
291
319
|
onLoadProgress?: ((progress: number) => any) | undefined;
|
|
292
320
|
onAfterGoToPage?: ((progress: number) => any) | undefined;
|
|
293
321
|
onPageChanged?: ((progress: number) => any) | undefined;
|
|
322
|
+
"onUpdate:scrollMode"?: ((scrollMode: ScrollMode) => any) | undefined;
|
|
323
|
+
"onUpdate:viewMode"?: ((viewMode: ViewMode) => any) | undefined;
|
|
294
324
|
}>, {
|
|
295
325
|
highlightControl: {
|
|
296
326
|
highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
|
|
@@ -353,11 +383,13 @@ declare const _default: {
|
|
|
353
383
|
} | undefined) => void;
|
|
354
384
|
};
|
|
355
385
|
}, {}, {}, {}, {
|
|
356
|
-
readonly
|
|
357
|
-
readonly
|
|
386
|
+
readonly scrollMode: ScrollMode;
|
|
387
|
+
readonly viewMode: ViewMode;
|
|
358
388
|
readonly workerUrl: string;
|
|
359
389
|
readonly initialPage: number;
|
|
360
390
|
readonly initialScale: number | ZoomLevel;
|
|
391
|
+
readonly initialScrollMode: ScrollMode;
|
|
392
|
+
readonly initialViewMode: ViewMode;
|
|
361
393
|
readonly initialRotation: number;
|
|
362
394
|
readonly initialThumbnailsVisible: boolean;
|
|
363
395
|
readonly initialSearch: string;
|
|
@@ -391,15 +423,25 @@ declare const _default: {
|
|
|
391
423
|
readonly type: import("vue").PropType<number | ZoomLevel>;
|
|
392
424
|
readonly default: () => ZoomLevel;
|
|
393
425
|
};
|
|
426
|
+
readonly scrollMode: {
|
|
427
|
+
readonly type: import("vue").PropType<ScrollMode>;
|
|
428
|
+
readonly default: () => ScrollMode;
|
|
429
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
430
|
+
};
|
|
431
|
+
readonly viewMode: {
|
|
432
|
+
readonly type: import("vue").PropType<ViewMode>;
|
|
433
|
+
readonly default: () => ViewMode;
|
|
434
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
435
|
+
};
|
|
394
436
|
readonly initialScrollMode: {
|
|
395
437
|
readonly type: import("vue").PropType<ScrollMode>;
|
|
396
438
|
readonly default: () => ScrollMode;
|
|
397
|
-
readonly validator: (
|
|
439
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
398
440
|
};
|
|
399
441
|
readonly initialViewMode: {
|
|
400
442
|
readonly type: import("vue").PropType<ViewMode>;
|
|
401
443
|
readonly default: () => ViewMode;
|
|
402
|
-
readonly validator: (
|
|
444
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
403
445
|
};
|
|
404
446
|
readonly initialRotation: {
|
|
405
447
|
readonly type: import("vue").PropType<number>;
|
|
@@ -463,6 +505,8 @@ declare const _default: {
|
|
|
463
505
|
onLoadProgress?: ((progress: number) => any) | undefined;
|
|
464
506
|
onAfterGoToPage?: ((progress: number) => any) | undefined;
|
|
465
507
|
onPageChanged?: ((progress: number) => any) | undefined;
|
|
508
|
+
"onUpdate:scrollMode"?: ((scrollMode: ScrollMode) => any) | undefined;
|
|
509
|
+
"onUpdate:viewMode"?: ((viewMode: ViewMode) => any) | undefined;
|
|
466
510
|
}>, {
|
|
467
511
|
highlightControl: {
|
|
468
512
|
highlight: (args: import("@/utils/types").TextHighlight[]) => Promise<Record<string, import("@/utils/types").MatchHighlightResult[]>>;
|
|
@@ -544,16 +588,22 @@ declare const _default: {
|
|
|
544
588
|
rotate: (rotateEvent: RotateEvent) => void;
|
|
545
589
|
} & {
|
|
546
590
|
scroll: (scrollEvent: Event) => void;
|
|
591
|
+
} & {
|
|
592
|
+
"update:scrollMode": (scrollMode: ScrollMode) => void;
|
|
593
|
+
} & {
|
|
594
|
+
"update:viewMode": (viewMode: ViewMode) => void;
|
|
547
595
|
} & {
|
|
548
596
|
afterGoToPage: (progress: number) => void;
|
|
549
597
|
} & {
|
|
550
598
|
pageChanged: (progress: number) => void;
|
|
551
599
|
}, string, {
|
|
552
|
-
readonly
|
|
553
|
-
readonly
|
|
600
|
+
readonly scrollMode: ScrollMode;
|
|
601
|
+
readonly viewMode: ViewMode;
|
|
554
602
|
readonly workerUrl: string;
|
|
555
603
|
readonly initialPage: number;
|
|
556
604
|
readonly initialScale: number | ZoomLevel;
|
|
605
|
+
readonly initialScrollMode: ScrollMode;
|
|
606
|
+
readonly initialViewMode: ViewMode;
|
|
557
607
|
readonly initialRotation: number;
|
|
558
608
|
readonly initialThumbnailsVisible: boolean;
|
|
559
609
|
readonly initialSearch: string;
|
|
@@ -362,6 +362,14 @@ export interface VPdfViewerProps {
|
|
|
362
362
|
* If unspecified, the initial zoom level is determined by the page dimensions and the width of the container
|
|
363
363
|
*/
|
|
364
364
|
initialScale?: number | ZoomLevel;
|
|
365
|
+
/**
|
|
366
|
+
* The scroll mode
|
|
367
|
+
*/
|
|
368
|
+
scrollMode?: ScrollMode;
|
|
369
|
+
/**
|
|
370
|
+
* The viewer mode
|
|
371
|
+
*/
|
|
372
|
+
viewMode?: ViewMode;
|
|
365
373
|
/**
|
|
366
374
|
* The initial scroll mode
|
|
367
375
|
*/
|
|
@@ -469,15 +477,25 @@ export declare const VPVBaseProps: {
|
|
|
469
477
|
readonly type: PropType<number | ZoomLevel>;
|
|
470
478
|
readonly default: () => ZoomLevel;
|
|
471
479
|
};
|
|
480
|
+
readonly scrollMode: {
|
|
481
|
+
readonly type: PropType<ScrollMode>;
|
|
482
|
+
readonly default: () => ScrollMode;
|
|
483
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
484
|
+
};
|
|
485
|
+
readonly viewMode: {
|
|
486
|
+
readonly type: PropType<ViewMode>;
|
|
487
|
+
readonly default: () => ViewMode;
|
|
488
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
489
|
+
};
|
|
472
490
|
readonly initialScrollMode: {
|
|
473
491
|
readonly type: PropType<ScrollMode>;
|
|
474
492
|
readonly default: () => ScrollMode;
|
|
475
|
-
readonly validator: (
|
|
493
|
+
readonly validator: (scrollMode: ScrollMode, args: unknown) => boolean;
|
|
476
494
|
};
|
|
477
495
|
readonly initialViewMode: {
|
|
478
496
|
readonly type: PropType<ViewMode>;
|
|
479
497
|
readonly default: () => ViewMode;
|
|
480
|
-
readonly validator: (
|
|
498
|
+
readonly validator: (viewMode: ViewMode, args: unknown) => boolean;
|
|
481
499
|
};
|
|
482
500
|
readonly initialRotation: {
|
|
483
501
|
readonly type: PropType<number>;
|
|
@@ -8,7 +8,10 @@ import { PDFSrc, VPdfViewerProps } from './types';
|
|
|
8
8
|
* @param warn - Whether to show console warnings for invalid combinations (default: true)
|
|
9
9
|
* @returns The validated scroll mode, defaulting to ScrollMode.Vertical if invalid
|
|
10
10
|
*/
|
|
11
|
-
export declare function getValidScrollMode(args:
|
|
11
|
+
export declare function getValidScrollMode(args: {
|
|
12
|
+
scrollMode: ScrollMode;
|
|
13
|
+
viewMode: ViewMode;
|
|
14
|
+
}, warn?: boolean): ScrollMode;
|
|
12
15
|
/**
|
|
13
16
|
* Validates the view mode based on the scroll mode settings.
|
|
14
17
|
* Some view modes are only compatible with certain scroll modes.
|
|
@@ -17,7 +20,7 @@ export declare function getValidScrollMode(args: Pick<VPdfViewerProps, 'initialV
|
|
|
17
20
|
* @param warn - Whether to show console warnings for invalid combinations (default: true)
|
|
18
21
|
* @returns The validated view mode, defaulting to ViewMode.SinglePage if invalid
|
|
19
22
|
*/
|
|
20
|
-
export declare function getValidViewMode(args: Pick<VPdfViewerProps, '
|
|
23
|
+
export declare function getValidViewMode(args: Pick<VPdfViewerProps, 'viewMode' | 'scrollMode'>, warn?: boolean): ViewMode;
|
|
21
24
|
/**
|
|
22
25
|
* Validates a PDF source (URL, Blob URL, or Vite-resolved file path).
|
|
23
26
|
* @param source - The PDF source to validate.
|