jit-viewer 1.1.3 → 1.2.0

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/README.md CHANGED
@@ -1,31 +1,39 @@
1
1
  # jit-viewer
2
2
 
3
- Document preview SDK for Vue, React, and vanilla JavaScript. Supports PDF, DOCX, XLSX/XLS, PPTX/PPT, OFD, TXT, Markdown, HTML, images, and built-in watermark rendering.
3
+ Document preview SDK for Vue 3, React, and vanilla JavaScript.
4
+
5
+ Supports PDF, DOCX, XLSX/XLS, CSV/TSV, PPTX/PPT, OFD, TXT, Markdown, HTML, images, video, built-in watermark rendering, and runtime-friendly request adapters.
4
6
 
5
7
  Chinese docs:
6
8
  - [README.zh-CN.md](./README.zh-CN.md)
7
- - [View on GitHub](https://github.com/jitOffice/jit-viewer-sdk/blob/main/packages/core/README.zh-CN.md)
9
+ - [CHANGELOG.md](./CHANGELOG.md)
10
+
11
+ ## What's New
12
+
13
+ ### 1.2.0 - 2026-04-02
14
+
15
+ - Added CSV / TSV preview with delimiter detection and table rendering
16
+ - Added native video preview for `mp4`, `webm`, `ogg`, `ogv`, and `mov`
17
+ - Improved HTML, image, and file-type routing in the viewer runtime
18
+ - Fixed CSV layout overflow so the preview stays inside the viewer container
19
+ - Fixed video loading flow for local upload and remote preview cases
20
+ - Hardened branding protection so CSS hiding can trigger warning and self-recovery more reliably
21
+
22
+ See the full history in [CHANGELOG.md](./CHANGELOG.md).
8
23
 
9
24
  ## Features
10
25
 
11
- - Multi-format preview: PDF, Office, OFD, Markdown, HTML, images
26
+ - Multi-format preview: PDF, Office, OFD, Markdown, HTML, images, video, CSV
12
27
  - Cross-framework usage: Vue 3, React, vanilla HTML/JS
13
28
  - Built-in toolbar: zoom, rotate, print, download, pagination
14
- - Theme and locale support: light / dark, zh-CN / en
29
+ - Theme and locale support: light / dark, `zh-CN` / `en`
15
30
  - Watermark support: text watermark, image watermark, opacity, rotation, tiling gap, top/bottom layer
16
- - Supports local files, remote URLs, Blob, ArrayBuffer, proxy URL, and custom request adapters
31
+ - File source support: local file, remote URL, Blob, ArrayBuffer, proxy URL, custom request adapter
17
32
 
18
33
  ## Installation
19
34
 
20
35
  ```bash
21
- # npm
22
36
  npm install jit-viewer
23
-
24
- # yarn
25
- yarn add jit-viewer
26
-
27
- # pnpm
28
- pnpm add jit-viewer
29
37
  ```
30
38
 
31
39
  ## Quick Start
@@ -48,10 +56,8 @@ let viewer: ReturnType<typeof createViewer> | null = null
48
56
  onMounted(() => {
49
57
  viewer = createViewer({
50
58
  target: containerRef.value!,
51
- file: '/demo/test.pdf',
59
+ file: '/demo/test.csv',
52
60
  toolbar: true,
53
- theme: 'light',
54
- locale: 'en',
55
61
  width: '100%',
56
62
  height: 640
57
63
  })
@@ -84,11 +90,12 @@ export default function App() {
84
90
  const viewerRef = useRef<ViewerInstance | null>(null)
85
91
 
86
92
  useEffect(() => {
87
- if (!containerRef.current) return
93
+ if (!containerRef.current)
94
+ return
88
95
 
89
96
  viewerRef.current = createViewer({
90
97
  target: containerRef.current,
91
- file: '/demo/test.pdf',
98
+ file: '/demo/test.mp4',
92
99
  toolbar: true,
93
100
  height: 640
94
101
  })
@@ -111,19 +118,17 @@ export default function App() {
111
118
  <meta charset="UTF-8" />
112
119
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
113
120
  <title>JitViewer Demo</title>
114
- <link rel="stylesheet" href="https://unpkg.com/jit-viewer/dist/iife/jit-viewer.min.css" />
121
+ <link rel="stylesheet" href="https://unpkg.com/jit-viewer@1.2.0/dist/iife/jit-viewer.min.css" />
115
122
  </head>
116
123
  <body>
117
124
  <div id="viewer" style="width:100%;height:640px;"></div>
118
125
 
119
- <script src="https://unpkg.com/jit-viewer/dist/iife/jit-viewer.min.js"></script>
126
+ <script src="https://unpkg.com/jit-viewer@1.2.0/dist/iife/jit-viewer.min.js"></script>
120
127
  <script>
121
128
  const viewer = JitViewer.createViewer({
122
129
  target: '#viewer',
123
130
  file: '/demo/test.pdf',
124
131
  toolbar: true,
125
- theme: 'light',
126
- locale: 'en',
127
132
  width: '100%',
128
133
  height: 640
129
134
  })
@@ -134,474 +139,54 @@ export default function App() {
134
139
  </html>
135
140
  ```
136
141
 
137
- ## Watermark
138
-
139
- Watermarks are configured via `ViewerOptions.watermark`. They affect only the preview layer and do not modify the source file.
140
-
141
- ### Text Watermark
142
-
143
- ```ts
144
- import { createViewer } from 'jit-viewer'
145
- import 'jit-viewer/style.css'
146
-
147
- const viewer = createViewer({
148
- target: '#viewer',
149
- file: '/demo/confidential.pdf',
150
- toolbar: true,
151
- watermark: {
152
- type: 'text',
153
- content: 'CONFIDENTIAL',
154
- fontSize: 20,
155
- color: '#bfbfbf',
156
- opacity: 0.22,
157
- rotate: -25,
158
- gapX: 140,
159
- gapY: 90,
160
- position: 'top'
161
- }
162
- })
163
-
164
- viewer.mount()
165
- ```
166
-
167
- ### Image Watermark
168
-
169
- ```ts
170
- import { createViewer } from 'jit-viewer'
171
- import 'jit-viewer/style.css'
172
-
173
- const viewer = createViewer({
174
- target: '#viewer',
175
- file: '/demo/report.pdf',
176
- watermark: {
177
- type: 'image',
178
- image: '/assets/company-logo.png',
179
- imageWidth: 96,
180
- imageHeight: 96,
181
- opacity: 0.16,
182
- rotate: -20,
183
- gapX: 180,
184
- gapY: 120,
185
- position: 'bottom'
186
- }
187
- })
188
-
189
- viewer.mount()
190
- ```
191
-
192
- ### Vue Component Example
193
-
194
- ```vue
195
- <template>
196
- <Viewer
197
- :file="file"
198
- :toolbar="true"
199
- :theme="'light'"
200
- :locale="'en'"
201
- :watermark="watermark"
202
- width="100%"
203
- height="640px"
204
- />
205
- </template>
206
-
207
- <script setup lang="ts">
208
- import { ref } from 'vue'
209
- import { Viewer } from 'jit-viewer'
210
- import 'jit-viewer/style.css'
211
-
212
- const file = ref('/demo/test.pdf')
213
-
214
- const watermark = ref({
215
- type: 'text' as const,
216
- content: 'JitViewer Demo',
217
- fontSize: 18,
218
- color: '#9aa5b1',
219
- opacity: 0.18,
220
- rotate: -30,
221
- gapX: 120,
222
- gapY: 80,
223
- position: 'top' as const
224
- })
225
- </script>
226
- ```
227
-
228
- ### Re-render With Different Watermarks
229
-
230
- ```ts
231
- import { createViewer, type ViewerInstance, type ViewerOptions } from 'jit-viewer'
232
-
233
- let viewer: ViewerInstance | null = null
234
-
235
- const baseOptions: ViewerOptions = {
236
- target: '#viewer',
237
- file: '/demo/test.pdf',
238
- toolbar: true,
239
- width: '100%',
240
- height: 640
241
- }
242
-
243
- function renderWithWatermark(watermark: ViewerOptions['watermark']) {
244
- viewer?.destroy()
245
-
246
- viewer = createViewer({
247
- ...baseOptions,
248
- watermark
249
- })
250
-
251
- viewer.mount()
252
- }
253
-
254
- renderWithWatermark({
255
- type: 'text',
256
- content: 'First Review',
257
- opacity: 0.2,
258
- rotate: -20,
259
- gapX: 140,
260
- gapY: 90
261
- })
262
-
263
- document.querySelector('#switchImage')?.addEventListener('click', () => {
264
- renderWithWatermark({
265
- type: 'image',
266
- image: '/assets/logo.png',
267
- imageWidth: 88,
268
- imageHeight: 88,
269
- opacity: 0.14,
270
- rotate: -18,
271
- gapX: 170,
272
- gapY: 110
273
- })
274
- })
275
-
276
- document.querySelector('#clearWatermark')?.addEventListener('click', () => {
277
- renderWithWatermark(null)
278
- })
279
- ```
280
-
281
- ## Detailed Examples
282
-
283
- ### Example 1: Contract Preview With Top-Level Confidential Watermark
284
-
285
- ```ts
286
- createViewer({
287
- target: '#viewer',
288
- file: '/contracts/nda.pdf',
289
- filename: 'nda.pdf',
290
- toolbar: true,
291
- pdfRender: 'inset',
292
- watermark: {
293
- type: 'text',
294
- content: 'CONFIDENTIAL',
295
- fontSize: 24,
296
- color: '#d4380d',
297
- opacity: 0.18,
298
- rotate: -32,
299
- gapX: 130,
300
- gapY: 85,
301
- position: 'top'
302
- }
303
- }).mount()
304
- ```
305
-
306
- ### Example 2: Handbook Preview With Brand Logo Watermark
307
-
308
- ```ts
309
- createViewer({
310
- target: '#viewer',
311
- file: '/manuals/employee-handbook.docx',
312
- toolbar: true,
313
- watermark: {
314
- type: 'image',
315
- image: '/assets/brand-watermark.svg',
316
- imageWidth: 72,
317
- imageHeight: 72,
318
- opacity: 0.1,
319
- rotate: -15,
320
- gapX: 210,
321
- gapY: 140,
322
- position: 'bottom'
323
- }
324
- }).mount()
325
- ```
326
-
327
- ### Example 3: Remote File With Auth Headers and Watermark
328
-
329
- ```ts
330
- createViewer({
331
- target: '#viewer',
332
- file: {
333
- url: 'https://api.example.com/files/statement.pdf',
334
- headers: {
335
- Authorization: 'Bearer your-token'
336
- }
337
- },
338
- requestAdapter: async (url, options) => {
339
- const response = await fetch(url, {
340
- method: options?.method || 'GET',
341
- headers: options?.headers
342
- })
343
-
344
- if (!response.ok) {
345
- throw new Error(`Request failed: ${response.status}`)
346
- }
347
-
348
- return response.arrayBuffer()
349
- },
350
- watermark: {
351
- type: 'text',
352
- content: 'Review Copy',
353
- fontSize: 16,
354
- color: '#7d8b99',
355
- opacity: 0.16,
356
- rotate: -28,
357
- gapX: 150,
358
- gapY: 100
359
- }
360
- }).mount()
361
- ```
362
-
363
- ## API
142
+ ## Core API
364
143
 
365
144
  ### `createViewer(options)`
366
145
 
367
- Creates a viewer instance and returns `ViewerInstance`.
368
-
369
- ### `ViewerOptions`
370
-
371
- | Option | Type | Default | Description |
372
- |------|------|--------|------|
373
- | `target` | `HTMLElement \| string` | - | Mount target |
374
- | `file` | `FileSource` | - | File source: URL, File, Blob, ArrayBuffer, or request object |
375
- | `type` | `FileType` | auto | Explicit file type |
376
- | `filename` | `string` | - | Display and download filename |
377
- | `toolbar` | `boolean \| ToolbarConfig` | `true` | Toolbar config |
378
- | `theme` | `'light' \| 'dark' \| ThemeConfig` | `'light'` | Theme |
379
- | `locale` | `'zh-CN' \| 'en' \| LocaleConfig` | `'zh-CN'` | Locale |
380
- | `width` | `string \| number` | `'100%'` | Viewer width |
381
- | `height` | `string \| number` | `'100%'` | Viewer height |
382
- | `className` | `string` | - | Custom class name |
383
- | `style` | `Record<string, string>` | - | Custom inline style |
384
- | `pdfRender` | `'native' \| 'inset'` | `'inset'` | PDF rendering mode |
385
- | `watermark` | `WatermarkConfig \| null` | `null` | Watermark config |
386
- | `proxyUrl` | `string` | - | Proxy URL |
387
- | `requestAdapter` | `RequestAdapter` | - | Custom fetch adapter |
388
- | `renderOptions` | `object` | - | Initial render options such as zoom, rotate, page |
389
- | `onReady` | `() => void` | - | Ready callback |
390
- | `onLoad` | `() => void` | - | Load callback |
391
- | `onError` | `(error: Error) => void` | - | Error callback |
392
- | `onDestroy` | `() => void` | - | Destroy callback |
393
-
394
- ### `WatermarkConfig`
146
+ Creates a viewer instance.
147
+
148
+ Key `ViewerOptions`:
395
149
 
396
150
  | Option | Type | Description |
397
- |------|------|------|
398
- | `type` | `'text' \| 'image'` | Watermark type |
399
- | `content` | `string` | Text content for `type: 'text'` |
400
- | `image` | `string` | Image URL for `type: 'image'` |
401
- | `fontSize` | `number` | Text font size in px |
402
- | `color` | `string` | Text color |
403
- | `fontFamily` | `string` | Font family |
404
- | `fontWeight` | `string \| number` | Font weight |
405
- | `imageWidth` | `number` | Image width in px |
406
- | `imageHeight` | `number` | Image height in px |
407
- | `opacity` | `number` | Opacity, usually between `0` and `1` |
408
- | `rotate` | `number` | Rotation angle in deg |
409
- | `gapX` | `number` | Horizontal gap |
410
- | `gapY` | `number` | Vertical gap |
411
- | `position` | `'top' \| 'bottom'` | Overlay above or below document content |
412
- | `width` | `string \| number` | Watermark container width |
413
- | `height` | `string \| number` | Watermark container height |
151
+ | --- | --- | --- |
152
+ | `target` | `HTMLElement \| string` | Mount target |
153
+ | `file` | `FileSource` | File source |
154
+ | `type` | `FileType` | Explicit file type when auto detection is not enough |
155
+ | `filename` | `string` | Display and download filename |
156
+ | `toolbar` | `ToolbarConfig \| boolean` | Toolbar config |
157
+ | `theme` | `Theme` | `light`, `dark`, or custom theme |
158
+ | `locale` | `Locale` | `zh-CN`, `en`, or custom locale |
159
+ | `watermark` | `WatermarkConfig \| null` | Preview watermark config |
160
+ | `proxyUrl` | `string` | Custom proxy endpoint |
161
+ | `requestAdapter` | `RequestAdapter` | Custom fetch adapter |
162
+ | `renderOptions` | `{ zoom?: number; rotate?: number; page?: number }` | Initial render state |
414
163
 
415
164
  ### `ViewerInstance`
416
165
 
417
166
  | Method | Description |
418
- |------|------|
419
- | `mount(target?)` | Mount viewer |
420
- | `destroy()` | Destroy viewer |
421
- | `setFile(file, filename?)` | Replace current file |
167
+ | --- | --- |
168
+ | `mount(target?)` | Mount the viewer |
169
+ | `destroy()` | Destroy the viewer |
170
+ | `setFile(file, filename?)` | Replace the current file |
171
+ | `setOptions(options)` | Update file, theme, toolbar, watermark, and runtime options |
422
172
  | `getFile()` | Get current file info |
423
173
  | `zoom(scale)` | Set zoom |
424
- | `rotate(degree)` | Set rotation |
425
- | `reset()` | Reset zoom and rotation |
174
+ | `rotate(degree)` | Rotate content |
175
+ | `reset()` | Reset zoom and rotate |
426
176
  | `fullscreen(enable?)` | Toggle fullscreen |
427
- | `prevPage()` | Previous page |
428
- | `nextPage()` | Next page |
429
- | `gotoPage(page)` | Go to page |
430
- | `getPageInfo()` | Get page info |
431
- | `print()` | Print current document |
432
- | `download()` | Download current document |
433
- | `setTheme(theme)` | Set theme |
434
- | `setLocale(locale)` | Set locale |
435
- | `setToolbar(config)` | Set toolbar |
436
- | `on(event, handler)` | Register event |
437
- | `off(event, handler)` | Remove event |
438
- | `getState()` | Get current state |
439
-
440
- ## Supported File Types
441
-
442
- | Format | Extensions | Description |
443
- |------|--------|------|
444
- | PDF | `.pdf` | PDF files |
445
- | Word | `.docx` | Microsoft Word |
446
- | Excel | `.xlsx`, `.xls` | Microsoft Excel |
447
- | PowerPoint | `.pptx`, `.ppt` | Microsoft PowerPoint |
448
- | OFD | `.ofd` | Open Fixed-layout Document |
449
- | Text | `.txt` | Plain text |
450
- | Markdown | `.md`, `.markdown` | Markdown files |
451
- | HTML | `.html`, `.htm` | HTML files or web content |
452
- | Images | `.jpg`, `.jpeg`, `.png`, `.gif`, `.webp`, `.svg`, `.bmp`, `.tiff`, `.tif`, `.ico` | Image preview |
453
-
454
- ## Browser Support
455
-
456
- - Chrome >= 80
457
- - Firefox >= 75
458
- - Safari >= 13
459
- - Edge >= 80
460
-
461
- ## License
462
-
463
- [Apache-2.0](./LICENSE)
464
-
465
- ## Links
466
-
467
- - [GitHub](https://github.com/jitOffice/jit-viewer-sdk)
468
- - [Homepage](https://jitword.com/jit-viewer.html)
469
- - [Issues](https://github.com/jitOffice/jit-viewer-sdk/issues)
470
-
471
- ---
472
-
473
- ## 中文文档
474
-
475
- 跨框架文档预览 SDK,支持 PDF、DOCX、XLSX/XLS、PPTX/PPT、OFD、TXT、Markdown、HTML、图片等多种格式,并内置文档水印能力。
476
-
477
- [Back to English](#jit-viewer)
478
-
479
- ## 特性
480
-
481
- - 多格式预览:PDF、Office、OFD、Markdown、HTML、图片
482
- - 跨框架使用:Vue 3、React、原生 HTML/JS
483
- - 内置工具栏:缩放、旋转、打印、下载、分页
484
- - 主题与国际化:浅色 / 深色,中文 / 英文
485
- - 水印能力:文本水印、图片水印、透明度、旋转、平铺间距、顶层/底层显示
486
- - 支持本地文件、远程 URL、Blob、ArrayBuffer、自定义请求适配器
487
-
488
- ## 安装
489
-
490
- ```bash
491
- # npm
492
- npm install jit-viewer
493
-
494
- # yarn
495
- yarn add jit-viewer
496
-
497
- # pnpm
498
- pnpm add jit-viewer
499
- ```
500
-
501
- ## 快速开始
502
-
503
- ### Vue 3
504
-
505
- ```vue
506
- <template>
507
- <div ref="containerRef" class="viewer-container"></div>
508
- </template>
509
-
510
- <script setup lang="ts">
511
- import { onMounted, onUnmounted, ref } from 'vue'
512
- import { createViewer } from 'jit-viewer'
513
- import 'jit-viewer/style.css'
514
-
515
- const containerRef = ref<HTMLElement | null>(null)
516
- let viewer: ReturnType<typeof createViewer> | null = null
517
-
518
- onMounted(() => {
519
- viewer = createViewer({
520
- target: containerRef.value!,
521
- file: '/demo/test.pdf',
522
- toolbar: true,
523
- theme: 'light',
524
- locale: 'zh-CN',
525
- width: '100%',
526
- height: 640
527
- })
528
-
529
- viewer.mount()
530
- })
531
-
532
- onUnmounted(() => {
533
- viewer?.destroy()
534
- })
535
- </script>
536
- ```
537
-
538
- ### React
177
+ | `prevPage()` / `nextPage()` / `gotoPage(page)` | Pagination controls |
178
+ | `getPageInfo()` | Get page state |
179
+ | `print()` | Print current view |
180
+ | `download()` | Download current file |
181
+ | `setTheme(theme)` | Update theme |
182
+ | `setLocale(locale)` | Update locale |
183
+ | `setToolbar(config)` | Update toolbar |
184
+ | `on(event, handler)` / `off(event, handler)` | Event subscription |
185
+ | `getState()` | Get runtime state |
539
186
 
540
- ```tsx
541
- import { useEffect, useRef } from 'react'
542
- import { createViewer, type ViewerInstance } from 'jit-viewer'
543
- import 'jit-viewer/style.css'
544
-
545
- export default function App() {
546
- const containerRef = useRef<HTMLDivElement | null>(null)
547
- const viewerRef = useRef<ViewerInstance | null>(null)
548
-
549
- useEffect(() => {
550
- if (!containerRef.current) return
551
-
552
- viewerRef.current = createViewer({
553
- target: containerRef.current,
554
- file: '/demo/test.pdf',
555
- toolbar: true,
556
- height: 640
557
- })
558
-
559
- viewerRef.current.mount()
560
-
561
- return () => viewerRef.current?.destroy()
562
- }, [])
563
-
564
- return <div ref={containerRef} style={{ width: '100%', height: 640 }} />
565
- }
566
- ```
567
-
568
- ### 原生 HTML / JS
569
-
570
- ```html
571
- <!DOCTYPE html>
572
- <html lang="zh-CN">
573
- <head>
574
- <meta charset="UTF-8" />
575
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
576
- <title>JitViewer Demo</title>
577
- <link rel="stylesheet" href="https://unpkg.com/jit-viewer/dist/iife/jit-viewer.min.css" />
578
- </head>
579
- <body>
580
- <div id="viewer" style="width:100%;height:640px;"></div>
581
-
582
- <script src="https://unpkg.com/jit-viewer/dist/iife/jit-viewer.min.js"></script>
583
- <script>
584
- const viewer = JitViewer.createViewer({
585
- target: '#viewer',
586
- file: '/demo/test.pdf',
587
- toolbar: true,
588
- theme: 'light',
589
- locale: 'zh-CN',
590
- width: '100%',
591
- height: 640
592
- })
593
-
594
- viewer.mount()
595
- </script>
596
- </body>
597
- </html>
598
- ```
599
-
600
- ## 水印使用
601
-
602
- 水印通过 `ViewerOptions.watermark` 配置,支持文本水印和图片水印。水印只作用于预览层,不会修改原始文件内容。
187
+ ## Watermark
603
188
 
604
- ### 文本水印
189
+ Watermarks are configured with `ViewerOptions.watermark`. They apply only to the preview layer and do not modify the original file.
605
190
 
606
191
  ```ts
607
192
  import { createViewer } from 'jit-viewer'
@@ -609,15 +194,12 @@ import 'jit-viewer/style.css'
609
194
 
610
195
  const viewer = createViewer({
611
196
  target: '#viewer',
612
- file: '/demo/confidential.pdf',
613
- toolbar: true,
197
+ file: '/demo/report.pdf',
614
198
  watermark: {
615
199
  type: 'text',
616
- content: '内部资料 严禁外传',
617
- fontSize: 20,
618
- color: '#bfbfbf',
619
- opacity: 0.22,
620
- rotate: -25,
200
+ content: 'CONFIDENTIAL',
201
+ opacity: 0.18,
202
+ rotate: -24,
621
203
  gapX: 140,
622
204
  gapY: 90,
623
205
  position: 'top'
@@ -627,306 +209,25 @@ const viewer = createViewer({
627
209
  viewer.mount()
628
210
  ```
629
211
 
630
- ### 图片水印
631
-
632
- ```ts
633
- import { createViewer } from 'jit-viewer'
634
- import 'jit-viewer/style.css'
635
-
636
- const viewer = createViewer({
637
- target: '#viewer',
638
- file: '/demo/report.pdf',
639
- watermark: {
640
- type: 'image',
641
- image: '/assets/company-logo.png',
642
- imageWidth: 96,
643
- imageHeight: 96,
644
- opacity: 0.16,
645
- rotate: -20,
646
- gapX: 180,
647
- gapY: 120,
648
- position: 'bottom'
649
- }
650
- })
651
-
652
- viewer.mount()
653
- ```
654
-
655
- ### Vue 组件方式
656
-
657
- ```vue
658
- <template>
659
- <Viewer
660
- :file="file"
661
- :toolbar="true"
662
- :theme="'light'"
663
- :locale="'zh-CN'"
664
- :watermark="watermark"
665
- width="100%"
666
- height="640px"
667
- />
668
- </template>
669
-
670
- <script setup lang="ts">
671
- import { ref } from 'vue'
672
- import { Viewer } from 'jit-viewer'
673
- import 'jit-viewer/style.css'
674
-
675
- const file = ref('/demo/test.pdf')
676
-
677
- const watermark = ref({
678
- type: 'text' as const,
679
- content: 'JitViewer Demo',
680
- fontSize: 18,
681
- color: '#9aa5b1',
682
- opacity: 0.18,
683
- rotate: -30,
684
- gapX: 120,
685
- gapY: 80,
686
- position: 'top' as const
687
- })
688
- </script>
689
- ```
690
-
691
- ### 动态切换不同水印
692
-
693
- ```ts
694
- import { createViewer, type ViewerInstance, type ViewerOptions } from 'jit-viewer'
212
+ ## Supported Formats
695
213
 
696
- let viewer: ViewerInstance | null = null
697
-
698
- const baseOptions: ViewerOptions = {
699
- target: '#viewer',
700
- file: '/demo/test.pdf',
701
- toolbar: true,
702
- width: '100%',
703
- height: 640
704
- }
705
-
706
- function renderWithWatermark(watermark: ViewerOptions['watermark']) {
707
- viewer?.destroy()
708
-
709
- viewer = createViewer({
710
- ...baseOptions,
711
- watermark
712
- })
713
-
714
- viewer.mount()
715
- }
716
-
717
- renderWithWatermark({
718
- type: 'text',
719
- content: '首次预览',
720
- opacity: 0.2,
721
- rotate: -20,
722
- gapX: 140,
723
- gapY: 90
724
- })
725
-
726
- document.querySelector('#switchImage')?.addEventListener('click', () => {
727
- renderWithWatermark({
728
- type: 'image',
729
- image: '/assets/logo.png',
730
- imageWidth: 88,
731
- imageHeight: 88,
732
- opacity: 0.14,
733
- rotate: -18,
734
- gapX: 170,
735
- gapY: 110
736
- })
737
- })
738
-
739
- document.querySelector('#clearWatermark')?.addEventListener('click', () => {
740
- renderWithWatermark(null)
741
- })
742
- ```
214
+ | Type | Extensions |
215
+ | --- | --- |
216
+ | PDF | `.pdf` |
217
+ | Word | `.docx` |
218
+ | Excel | `.xlsx`, `.xls` |
219
+ | CSV | `.csv`, `.tsv` |
220
+ | PowerPoint | `.pptx`, `.ppt` |
221
+ | OFD | `.ofd` |
222
+ | Text | `.txt` |
223
+ | Markdown | `.md`, `.markdown` |
224
+ | HTML | `.html`, `.htm` |
225
+ | Images | `.jpg`, `.jpeg`, `.png`, `.gif`, `.webp`, `.svg`, `.bmp`, `.tiff`, `.tif`, `.ico` |
226
+ | Video | `.mp4`, `.webm`, `.ogg`, `.ogv`, `.mov` |
743
227
 
744
- ## 详细示例
745
-
746
- ### 示例 1:合同预览 + 顶层保密文本水印
747
-
748
- ```ts
749
- createViewer({
750
- target: '#viewer',
751
- file: '/contracts/nda.pdf',
752
- filename: 'nda.pdf',
753
- toolbar: true,
754
- pdfRender: 'inset',
755
- watermark: {
756
- type: 'text',
757
- content: 'CONFIDENTIAL',
758
- fontSize: 24,
759
- color: '#d4380d',
760
- opacity: 0.18,
761
- rotate: -32,
762
- gapX: 130,
763
- gapY: 85,
764
- position: 'top'
765
- }
766
- }).mount()
767
- ```
768
-
769
- ### 示例 2:员工手册预览 + 底层品牌 Logo 水印
770
-
771
- ```ts
772
- createViewer({
773
- target: '#viewer',
774
- file: '/manuals/employee-handbook.docx',
775
- toolbar: true,
776
- watermark: {
777
- type: 'image',
778
- image: '/assets/brand-watermark.svg',
779
- imageWidth: 72,
780
- imageHeight: 72,
781
- opacity: 0.1,
782
- rotate: -15,
783
- gapX: 210,
784
- gapY: 140,
785
- position: 'bottom'
786
- }
787
- }).mount()
788
- ```
789
-
790
- ### 示例 3:自定义请求头 + 水印
791
-
792
- ```ts
793
- createViewer({
794
- target: '#viewer',
795
- file: {
796
- url: 'https://api.example.com/files/statement.pdf',
797
- headers: {
798
- Authorization: 'Bearer your-token'
799
- }
800
- },
801
- requestAdapter: async (url, options) => {
802
- const response = await fetch(url, {
803
- method: options?.method || 'GET',
804
- headers: options?.headers
805
- })
806
-
807
- if (!response.ok) {
808
- throw new Error(`Request failed: ${response.status}`)
809
- }
810
-
811
- return response.arrayBuffer()
812
- },
813
- watermark: {
814
- type: 'text',
815
- content: '审阅版',
816
- fontSize: 16,
817
- color: '#7d8b99',
818
- opacity: 0.16,
819
- rotate: -28,
820
- gapX: 150,
821
- gapY: 100
822
- }
823
- }).mount()
824
- ```
825
-
826
- ## API
827
-
828
- ### `createViewer(options)`
829
-
830
- 创建预览器实例,返回 `ViewerInstance`。
831
-
832
- ### `ViewerOptions`
833
-
834
- | 参数 | 类型 | 默认值 | 说明 |
835
- |------|------|--------|------|
836
- | `target` | `HTMLElement \| string` | - | 挂载目标元素 |
837
- | `file` | `FileSource` | - | 文件源,支持 URL、File、Blob、ArrayBuffer、带请求参数对象 |
838
- | `type` | `FileType` | 自动识别 | 手动指定文件类型 |
839
- | `filename` | `string` | - | 文件名,用于显示和下载 |
840
- | `toolbar` | `boolean \| ToolbarConfig` | `true` | 工具栏配置 |
841
- | `theme` | `'light' \| 'dark' \| ThemeConfig` | `'light'` | 主题配置 |
842
- | `locale` | `'zh-CN' \| 'en' \| LocaleConfig` | `'zh-CN'` | 语言配置 |
843
- | `width` | `string \| number` | `'100%'` | 预览器宽度 |
844
- | `height` | `string \| number` | `'100%'` | 预览器高度 |
845
- | `className` | `string` | - | 自定义类名 |
846
- | `style` | `Record<string, string>` | - | 自定义样式 |
847
- | `pdfRender` | `'native' \| 'inset'` | `'inset'` | PDF 预览方式 |
848
- | `watermark` | `WatermarkConfig \| null` | `null` | 文档水印配置 |
849
- | `proxyUrl` | `string` | - | 自定义代理地址 |
850
- | `requestAdapter` | `RequestAdapter` | - | 自定义请求适配器 |
851
- | `renderOptions` | `object` | - | 初始缩放、旋转、页码等渲染配置 |
852
- | `onReady` | `() => void` | - | 预览器就绪回调 |
853
- | `onLoad` | `() => void` | - | 文件加载完成回调 |
854
- | `onError` | `(error: Error) => void` | - | 错误回调 |
855
- | `onDestroy` | `() => void` | - | 销毁回调 |
856
-
857
- ### `WatermarkConfig`
858
-
859
- | 参数 | 类型 | 说明 |
860
- |------|------|------|
861
- | `type` | `'text' \| 'image'` | 水印类型 |
862
- | `content` | `string` | 文本水印内容,`type: 'text'` 时使用 |
863
- | `image` | `string` | 图片地址,`type: 'image'` 时使用 |
864
- | `fontSize` | `number` | 文字字号,单位 `px` |
865
- | `color` | `string` | 文字颜色 |
866
- | `fontFamily` | `string` | 文字字体 |
867
- | `fontWeight` | `string \| number` | 字重 |
868
- | `imageWidth` | `number` | 图片水印宽度,单位 `px` |
869
- | `imageHeight` | `number` | 图片水印高度,单位 `px` |
870
- | `opacity` | `number` | 透明度,范围建议 `0 ~ 1` |
871
- | `rotate` | `number` | 旋转角度,单位 `deg` |
872
- | `gapX` | `number` | 水平平铺间距 |
873
- | `gapY` | `number` | 垂直平铺间距 |
874
- | `position` | `'top' \| 'bottom'` | 显示在文档上方或下方 |
875
- | `width` | `string \| number` | 水印容器宽度 |
876
- | `height` | `string \| number` | 水印容器高度 |
877
-
878
- ### `ViewerInstance`
879
-
880
- | 方法 | 说明 |
881
- |------|------|
882
- | `mount(target?)` | 挂载到目标容器 |
883
- | `destroy()` | 销毁实例 |
884
- | `setFile(file, filename?)` | 动态切换文件 |
885
- | `getFile()` | 获取当前文件信息 |
886
- | `zoom(scale)` | 设置缩放比例 |
887
- | `rotate(degree)` | 设置旋转角度 |
888
- | `reset()` | 重置缩放和旋转 |
889
- | `fullscreen(enable?)` | 切换全屏 |
890
- | `prevPage()` | 上一页 |
891
- | `nextPage()` | 下一页 |
892
- | `gotoPage(page)` | 跳转到指定页 |
893
- | `getPageInfo()` | 获取页码信息 |
894
- | `print()` | 打印当前文档 |
895
- | `download()` | 下载当前文档 |
896
- | `setTheme(theme)` | 设置主题 |
897
- | `setLocale(locale)` | 设置语言 |
898
- | `setToolbar(config)` | 设置工具栏 |
899
- | `on(event, handler)` | 监听事件 |
900
- | `off(event, handler)` | 取消监听事件 |
901
- | `getState()` | 获取当前状态 |
902
-
903
- ## 支持的文件格式
904
-
905
- | 格式 | 扩展名 | 说明 |
906
- |------|--------|------|
907
- | PDF | `.pdf` | PDF 文档 |
908
- | Word | `.docx` | Microsoft Word 文档 |
909
- | Excel | `.xlsx`, `.xls` | Microsoft Excel 表格 |
910
- | PowerPoint | `.pptx`, `.ppt` | Microsoft PowerPoint 演示文稿 |
911
- | OFD | `.ofd` | 电子公文格式 |
912
- | 文本 | `.txt` | 纯文本文件 |
913
- | Markdown | `.md`, `.markdown` | Markdown 文档 |
914
- | HTML | `.html`, `.htm` | HTML 文件或网页内容 |
915
- | 图片 | `.jpg`, `.jpeg`, `.png`, `.gif`, `.webp`, `.svg`, `.bmp`, `.tiff`, `.tif`, `.ico` | 图片预览 |
916
-
917
- ## 浏览器支持
918
-
919
- - Chrome >= 80
920
- - Firefox >= 75
921
- - Safari >= 13
922
- - Edge >= 80
923
-
924
- ## 许可证
925
-
926
- [Apache-2.0](./LICENSE)
927
-
928
- ## 链接
228
+ ## Links
929
229
 
230
+ - [Chinese README](./README.zh-CN.md)
231
+ - [Changelog](./CHANGELOG.md)
930
232
  - [GitHub](https://github.com/jitOffice/jit-viewer-sdk)
931
- - [主页](https://jitword.com/jit-viewer.html)
932
- - [问题反馈](https://github.com/jitOffice/jit-viewer-sdk/issues)
233
+ - [Homepage](https://jitword.com/jit-viewer.html)