Skip to content

Commit d02d02c

Browse files
committed
Update PDF.js version, add missing parameters for viewer, minify build
1 parent 02e74c0 commit d02d02c

14 files changed

+232
-61
lines changed

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,22 @@ Supported in all [major browsers](https://caniuse.com/custom-elementsv1), and wo
1010
See [demo pages](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/demo) for various usecases.
1111
See [live examples](https://alekswebnet.github.io/pdfjs-viewer-element/#demo) of usage with frameworks.
1212

13+
# Features
14+
15+
- Simple PDF.js viewer integration to any web application
16+
- PDF.js viewer options and parameters support, access to the viewer application instance
17+
- Ability to customize viewer styles and themes
18+
1319
## How it works
1420

15-
**⚠️ This is an important part !!!**
21+
**⚠️ This is an important part, please read this firstly !!!**
1622

1723
**You should download and place the PDF.js prebuilt files in the project.**
1824

1925
`pdfjs-viewer-element` requires PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/), that includes the generic build of PDF.js and the viewer.
2026

21-
The prebuilt comes with each PDF.js release. Supported all v4 and v3 [releases](https://github.com/mozilla/pdf.js/releases).
27+
The prebuilt comes with each PDF.js release.
28+
All v4 and v3 [releases](https://github.com/mozilla/pdf.js/releases) are supported.
2229

2330
Then specify the path to the directory with the `viewer-path` property (`/pdfjs` by default) and PDF file URL with `src` property (should refer to the [same origin](https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions#can-i-load-a-pdf-from-another-server-cross-domain-request)).
2431

@@ -64,7 +71,7 @@ Using browser:
6471
## Usage
6572

6673
```html
67-
<pdfjs-viewer-element src="/file.pdf" viewer-path="/pdfjs-4.5.136-dist"></pdfjs-viewer-element>
74+
<pdfjs-viewer-element src="/file.pdf" viewer-path="/pdfjs-4.10.38-dist"></pdfjs-viewer-element>
6875
```
6976

7077
## Attributes
@@ -73,27 +80,39 @@ Using browser:
7380

7481
`viewer-path` - Path to PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/)
7582

76-
`locale` - Specifies which language to use in the viewer UI `en-US | ...`. [Available locales](https://github.com/mozilla/pdf.js/tree/master/l10n)
83+
`page` - Page number.
84+
85+
`nameddest` - Go to a named destination.
86+
87+
`search` - Search text.
88+
89+
`phrase` - Search by phrase, `true` to enable.
90+
91+
`zoom` - Zoom level.
92+
93+
`pagemode` - Page mode, `thumbs | bookmarks | attachments | layers | none`.
94+
95+
`disable-worker` - Disables the worker, `true` to enable.
7796

78-
`text-layer` - Text layer, that is used for text selection `off | visible | shadow | hover`
97+
`text-layer` - Disables or reveals the text layer that is used for text selection, `off | visible | shadow | hover`.
7998

80-
`page` - Page number
99+
`disable-font-face` - Disables standard `@font-face` font loading and uses the internal font renderer instead, `true` to enable.
81100

82-
`nameddest` - Go to a named destination
101+
`disable-range` - Disables HTTP range requests when fetching the document, `true` to enable.
83102

84-
`search` - Search text
103+
`disable-stream` - Disables streaming when fetching the document, `true` to enable.
85104

86-
`phrase` - Search by phrase
105+
`disable-auto-fetch`- Disables auto fetching of the document; only gets necessary data to display the current view. Note: streaming also needs to be disabled for this to have any effect, `true` to enable.
87106

88-
`zoom` - Zoom level
107+
`verbosity`- Specifies the verbosity level of console messages. `0` - only errors, `1` - warnings and errors, `5` - warnings, errors and information messages.
89108

90-
`pagemode` - Page mode `thumbs | bookmarks | attachments | layers | none`
109+
`locale` - Specifies which language to use in the viewer UI, `en-US | ...`. [Available locales](https://github.com/mozilla/pdf.js/tree/master/l10n)
91110

92-
`viewer-css-theme` - Apply automatic, light, or dark theme `AUTOMATIC | LIGHT | DARK`
111+
`viewer-css-theme` - Apply automatic, light, or dark theme, `AUTOMATIC | LIGHT | DARK`
93112

94-
`viewer-extra-styles` - Add your CSS rules to the viewer application
113+
`viewer-extra-styles` - Add your CSS rules to the viewer application, pass a string with styles.
95114

96-
`viewer-extra-styles-urls` - Add external CSS files to the viewer application
115+
`viewer-extra-styles-urls` - Add external CSS files to the viewer application, pass an array with URLs.
97116

98117
Play with attributes on [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
99118

@@ -104,19 +123,19 @@ Use `viewer-css-theme` attribute to set light or dark theme manually:
104123
```html
105124
<pdfjs-viewer-element
106125
src="/file.pdf"
107-
viewer-path="/pdfjs-4.5.136-dist"
126+
viewer-path="/pdfjs-4.10.38-dist"
108127
viewer-css-theme="DARK">
109128
</pdfjs-viewer-element>
110129
```
111130

112-
## Viewer extra styles
131+
## Viewer custom styles
113132

114133
You can add your own CSS rules to the viewer application using `viewer-extra-styles` or `viewer-extra-styles-urls` attribute:
115134

116135
```html
117136
<pdfjs-viewer-element
118137
src="/file.pdf"
119-
viewer-path="/pdfjs-4.5.136-dist"
138+
viewer-path="/pdfjs-4.10.38-dist"
120139
viewer-extra-styles="#toolbarViewerMiddle { display: none; }"
121140
viewer-extra-styles-urls="['/demo/viewer-custom-theme.css']">
122141
</pdfjs-viewer-element>
@@ -149,7 +168,7 @@ Build your own theme with viewer's custom variables and `viewer-extra-styles-url
149168
`initialize` - using this method you can access PDFViewerApplication and use methods and events of PDF.js default viewer
150169

151170
```html
152-
<pdfjs-viewer-element viewer-path="/pdfjs-4.5.136-dist"></pdfjs-viewer-element>
171+
<pdfjs-viewer-element viewer-path="/pdfjs-4.10.38-dist"></pdfjs-viewer-element>
153172
```
154173

155174
```javascript

demo/basic.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
src="/public/sample-pdf-with-images.pdf"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
style="height: 100dvh">
2121
</pdfjs-viewer-element>
2222
</body>

demo/dark-theme.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
src="/public/sample-pdf-with-images.pdf"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
viewer-css-theme="DARK"
2121
style="height: 100dvh">
2222
</pdfjs-viewer-element>

demo/extra-styles-urls.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
src="/public/sample-pdf-with-images.pdf"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
viewer-extra-styles-urls="['/demo/viewer-custom-theme.css']"
2121
style="height: 100dvh">
2222
</pdfjs-viewer-element>

demo/extra-styles.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
src="/public/sample-pdf-with-images.pdf"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
viewer-extra-styles="#toolbarViewerMiddle { display: none; }"
2121
style="height: 100dvh">
2222
</pdfjs-viewer-element>

demo/go-to-nameddest.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
src="/public/sample-pdf-report.pdf"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
nameddest="chart"
2121
style="height: 100dvh">
2222
</pdfjs-viewer-element>

demo/opened-findbar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<pdfjs-viewer-element
1818
id="viewer"
1919
src="/public/sample-pdf-with-images.pdf"
20-
viewer-path="/public/pdfjs-4.5.136-dist"
20+
viewer-path="/public/pdfjs-4.10.38-dist"
2121
style="height: 100dvh">
2222
</pdfjs-viewer-element>
2323

demo/pdf-data-load.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<body>
1717
<pdfjs-viewer-element
1818
id="viewer"
19-
viewer-path="/public/pdfjs-4.5.136-dist"
19+
viewer-path="/public/pdfjs-4.10.38-dist"
2020
style="height: 100dvh">
2121
</pdfjs-viewer-element>
2222

index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@
1010
<body style="margin: 0">
1111
<pdfjs-viewer-element
1212
src="/fake-file.pdf"
13-
viewer-path="/pdfjs-4.5.136-dist"
13+
viewer-path="/pdfjs-4.10.38-dist"
1414
style="height: 600px">
1515
</pdfjs-viewer-element>
1616
<pdfjs-viewer-element
1717
id="hideOpenFileViewer"
1818
src="/sample-pdf-with-images.pdf"
19-
viewer-path="/pdfjs-4.5.136-dist"
19+
viewer-path="/pdfjs-4.10.38-dist"
2020
locale="de"
2121
page="2"
2222
style="height: 600px">
2323
</pdfjs-viewer-element>
24-
<button onclick="document.querySelector('#hideOpenFileViewer').setAttribute('viewer-extra-styles', '#download { display: none }')">Hide download button</button>
24+
<button onclick="document.querySelector('#hideOpenFileViewer').setAttribute('viewer-extra-styles', '#downloadButton { display: none }')">Hide download button</button>
2525
<button onclick="document.querySelector('#hideOpenFileViewer').setAttribute('viewer-extra-styles', '')">Show download button</button>
2626
<pdfjs-viewer-element
2727
id="themedViewer"
2828
src="/sample-pdf-10MB.pdf"
29-
viewer-path="/pdfjs-4.5.136-dist"
29+
viewer-path="/pdfjs-4.10.38-dist"
3030
viewer-css-theme="DARK"
3131
locale="es"
3232
style="height: 600px">
@@ -47,7 +47,7 @@
4747

4848
<pdfjs-viewer-element
4949
id="base-viewer"
50-
viewer-path="/pdfjs-4.5.136-dist"
50+
viewer-path="/pdfjs-4.10.38-dist"
5151
locale="uk"
5252
style="height: clamp(600px, 600px, 80dvh)">
5353
</pdfjs-viewer-element>

package.json

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "pdfjs-viewer-element",
3-
"version": "2.6.5",
3+
"version": "2.7.0",
44
"license": "MIT",
55
"author": {
66
"name": "Oleksandr Shevchuk",
@@ -11,7 +11,9 @@
1111
"pdfjs",
1212
"pdf viewer",
1313
"pdfjs viewer",
14-
"web component"
14+
"web component",
15+
"pdfjs viewer element",
16+
"pdf"
1517
],
1618
"main": "./dist/pdfjs-viewer-element.js",
1719
"module": "./dist/pdfjs-viewer-element.js",
@@ -37,14 +39,17 @@
3739
},
3840
"devDependencies": {
3941
"@awlsn/pdfjs-full": "^4.2.392",
42+
"@rollup/plugin-terser": "^0.4.4",
4043
"@types/node": "^18.19.31",
4144
"@vitest/browser": "^1.5.0",
4245
"jsdom": "^22.1.0",
43-
"perfect-debounce": "^1.0.0",
4446
"typescript": "^4.9.5",
4547
"vite": "^5.2.9",
4648
"vitest": "^1.5.0",
4749
"webdriverio": "^8.36.1"
4850
},
49-
"packageManager": "pnpm@9.7.0+sha512.dc09430156b427f5ecfc79888899e1c39d2d690f004be70e05230b72cb173d96839587545d09429b55ac3c429c801b4dc3c0e002f653830a420fa2dd4e3cf9cf"
51+
"packageManager": "pnpm@9.7.0+sha512.dc09430156b427f5ecfc79888899e1c39d2d690f004be70e05230b72cb173d96839587545d09429b55ac3c429c801b4dc3c0e002f653830a420fa2dd4e3cf9cf",
52+
"dependencies": {
53+
"perfect-debounce": "^1.0.0"
54+
}
5055
}

0 commit comments

Comments
 (0)