pdfjs-viewer-element 2.7.3 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oleksandr Shevchuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -7,16 +7,20 @@ The package provides a custom element, based on PDF.js [viewer options](https://
 Supported in all [major browsers](https://caniuse.com/custom-elementsv1), and works with most [JS frameworks](https://custom-elements-everywhere.com/).
 
 [![npm version](https://img.shields.io/npm/v/pdfjs-viewer-element?logo=npm&logoColor=fff)](https://www.npmjs.com/package/pdfjs-viewer-element)
-[![Package Quality](https://packagequality.com/shield/pdfjs-viewer-element.svg)](https://packagequality.com/#?package=pdfjs-viewer-element)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/alekswebnet/pdfjs-viewer-element)
 [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/pdfjs-viewer-element)
 
 ![PDF.js viewer](image.webp)
 
 ## Features
 
-- Simple PDF.js viewer integration to any web application
-- PDF.js viewer options and parameters support, access the viewer application instance
-- Customize viewer styles and themes
+- Standalone web component with no runtime dependencies
+- Drop-in, iframe-based PDF.js default viewer for any web app
+- Configure via attributes and URL parameters (page, zoom, search, pagemode, locale, named destination)
+- Programmatic access to `PDFViewerApplication` and `PDFViewerApplicationOptions` via the `initialized` event
+- Theme control (automatic/light/dark) plus custom CSS injection or external stylesheets
+- Locale override support using PDF.js viewer locales
+- Works in modern browsers and most JS frameworks
 
 ## Docs
 
@@ -24,33 +28,7 @@ Supported in all [major browsers](https://caniuse.com/custom-elementsv1), and wo
 
 [API playground](https://alekswebnet.github.io/pdfjs-viewer-element/#api)
 
-[Usage with frameworks](https://alekswebnet.github.io/pdfjs-viewer-element/#demo)
-
-[Various usecases](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/demo)
-
-## Support via Ko-fi
-
-If you find `pdfjs-viewer-element` useful and want to support its development, consider making a donation via Ko-fi:
-
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/oleksandrshevchuk)
-
-> ❤️ Your support helps with maintenance, bug fixes, and long-term improvements.
-
-## How it works
-
-**⚠️ This is an important part, please read this FIRST !!!**
-
- **You should download and place the PDF.js prebuilt files in the project.**
-
-`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.
-
-The prebuilt comes with each PDF.js release. [PDF.JS releases](https://github.com/mozilla/pdf.js/releases)
-
-✅ All v4 and v3 releases are fully supported.
-
-🚧 For v5 releases - there are some breaking changes that affects styles injecting, and theme changing not work anymore.
-
-After placing the prebuild 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)).
+[Various use cases](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/demo)
 
 ## Install
 
@@ -59,8 +37,6 @@ After placing the prebuild specify the path to the directory with the `viewer-pa
 ```bash
 # With npm
 npm install pdfjs-viewer-element
-# With yarn
-yarn add pdfjs-viewer-element
 # With pnpm
 pnpm add pdfjs-viewer-element
 ```
@@ -78,19 +54,17 @@ import 'pdfjs-viewer-element'
 ## Usage
 
 ```html
-<pdfjs-viewer-element src="/file.pdf" viewer-path="/pdfjs-5.3.93-dist"></pdfjs-viewer-element>
+<pdfjs-viewer-element src="path-to/file.pdf"></pdfjs-viewer-element>
 ```
 
 ## Attributes
 
 `src` - PDF file URL, 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) 
 
-`viewer-path` - Path to PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/)
+`iframe-title` - The title of the `iframe` element, required for better accessibility
 
 `page` - Page number.
 
-`nameddest` -  Go to a named destination.
-
 `search` - Search text.
 
 `phrase` - Search by phrase, `true` to enable.
@@ -99,20 +73,6 @@ import 'pdfjs-viewer-element'
 
 `pagemode` - Page mode, `thumbs | bookmarks | attachments | layers | none`.
 
-`disable-worker` - Disables the worker, `true` to enable.
-
-`text-layer` - Disables or reveals the text layer that is used for text selection, `off | visible | shadow | hover`.
-
-`disable-font-face` - Disables standard `@font-face` font loading and uses the internal font renderer instead, `true` to enable.
-
-`disable-range` - Disables HTTP range requests when fetching the document, `true` to enable.
-
-`disable-stream` - Disables streaming when fetching the document, `true` to enable.
-
-`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.
-
-`verbosity`- Specifies the verbosity level of console messages. `0` - only errors, `1` - warnings and errors, `5` - warnings, errors and information messages.
-
 `locale` -  Specifies which language to use in the viewer UI, `en-US | ...`. [Available locales](https://github.com/mozilla/pdf.js/tree/master/l10n)
 
 `viewer-css-theme` - Apply automatic, light, or dark theme, `AUTOMATIC | LIGHT | DARK`
@@ -121,7 +81,7 @@ import 'pdfjs-viewer-element'
 
 `viewer-extra-styles-urls` - Add external CSS files to the viewer application, pass an array with URLs.
 
-Play with attributes on [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
+Play with attributes on [API docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
 
 ## Viewer CSS theme
 
@@ -130,7 +90,6 @@ Use `viewer-css-theme` attribute to set light or dark theme manually:
 ```html
 <pdfjs-viewer-element 
   src="/file.pdf" 
-  viewer-path="/pdfjs-5.3.93-dist"
   viewer-css-theme="DARK">
 </pdfjs-viewer-element>
 ```
@@ -142,7 +101,6 @@ You can add your own CSS rules to the viewer application using `viewer-extra-sty
 ```html
 <pdfjs-viewer-element 
   src="/file.pdf" 
-  viewer-path="/pdfjs-5.3.93-dist"
   viewer-extra-styles="#toolbarViewerMiddle { display: none; }"
   viewer-extra-styles-urls="['/demo/viewer-custom-theme.css']">
 </pdfjs-viewer-element>
@@ -170,29 +128,40 @@ Build your own theme with viewer's custom variables and `viewer-extra-styles-url
 }
 ```
 
-## PDF.js Viewer Application
-
-`initialize` - using this method you can access PDFViewerApplication and use methods and events of PDF.js default viewer
+## PDF.js Viewer Application and Options
 
 ```html
-<pdfjs-viewer-element viewer-path="/pdfjs-5.3.93-dist"></pdfjs-viewer-element>
+<pdfjs-viewer-element></pdfjs-viewer-element>
 ```
 
 ```javascript
-const viewer = document.querySelector('pdfjs-viewer-element')
-// Wait for the viewer initialization, receive PDFViewerApplication
-const viewerApp = await viewer.initialize()
-// Open PDF file data using Uint8Array instead of URL
-viewerApp.open({ data: pdfData })
+// Open PDF file programmatically accessing the viewer application
+document.addEventListener('DOMContentLoaded', async () => {
+  document.querySelector('pdfjs-viewer-element').addEventListener('initialized', (event) => {
+    const { viewerApp, viewerOptions } = event.detail
+    viewerApp.open({ data: pdfData })
+  })
+})
 ```
 
+## Events
+
+`initialized` - Fired after the PDF.js viewer is ready (after `PDFViewerApplication.initializedPromise` resolves). The event `detail` contains:
+
+- `viewerApp` (`PDFViewerApplication`)
+- `viewerOptions` (`PDFViewerApplicationOptions`)
+
+## Accessibility
+
+Use `iframe-title` to add a title to the `iframe` element and improve accessibility.
+
 ## Known issues
 
 ### The `.mjs` files support
 
 Since v4 PDF.js requires `.mjs` files support, make sure your server has it.
 
-In case of `nginx` this may causes to errors, see https://github.com/mozilla/pdf.js/issues/17296
+In case of `nginx` this may cause errors, see https://github.com/mozilla/pdf.js/issues/17296
 
 Add `.mjs` files support for `nginx` example:
 
@@ -213,13 +182,13 @@ server {
 }
 ```
 
-### Problem with range requests / streaming
+## Support via Ko-fi
 
-Sometimes a PDF file fails to load when working with range requests / streaming.
-If you encounter this issue, you can try disabling the broken functionality of PDF.js:
+If you find `pdfjs-viewer-element` useful and want to support its development, consider making a donation via Ko-fi:
 
-`disable-range="true"`
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/oleksandrshevchuk)
 
+> ❤️ Your support helps with maintenance, bug fixes, and long-term improvements.
 
 ## License
 [MIT](http://opensource.org/licenses/MIT)

package/dist/locale-BcpxbQPE.js

@@ -0,0 +1,4 @@
+const e = '{"ach":"ach/viewer.ftl","af":"af/viewer.ftl","an":"an/viewer.ftl","ar":"ar/viewer.ftl","ast":"ast/viewer.ftl","az":"az/viewer.ftl","be":"be/viewer.ftl","bg":"bg/viewer.ftl","bn":"bn/viewer.ftl","bo":"bo/viewer.ftl","br":"br/viewer.ftl","brx":"brx/viewer.ftl","bs":"bs/viewer.ftl","ca":"ca/viewer.ftl","cak":"cak/viewer.ftl","ckb":"ckb/viewer.ftl","cs":"cs/viewer.ftl","cy":"cy/viewer.ftl","da":"da/viewer.ftl","de":"de/viewer.ftl","dsb":"dsb/viewer.ftl","el":"el/viewer.ftl","en-ca":"en-CA/viewer.ftl","en-gb":"en-GB/viewer.ftl","en-us":"en-US/viewer.ftl","eo":"eo/viewer.ftl","es-ar":"es-AR/viewer.ftl","es-cl":"es-CL/viewer.ftl","es-es":"es-ES/viewer.ftl","es-mx":"es-MX/viewer.ftl","et":"et/viewer.ftl","eu":"eu/viewer.ftl","fa":"fa/viewer.ftl","ff":"ff/viewer.ftl","fi":"fi/viewer.ftl","fr":"fr/viewer.ftl","fur":"fur/viewer.ftl","fy-nl":"fy-NL/viewer.ftl","ga-ie":"ga-IE/viewer.ftl","gd":"gd/viewer.ftl","gl":"gl/viewer.ftl","gn":"gn/viewer.ftl","gu-in":"gu-IN/viewer.ftl","he":"he/viewer.ftl","hi-in":"hi-IN/viewer.ftl","hr":"hr/viewer.ftl","hsb":"hsb/viewer.ftl","hu":"hu/viewer.ftl","hy-am":"hy-AM/viewer.ftl","hye":"hye/viewer.ftl","ia":"ia/viewer.ftl","id":"id/viewer.ftl","is":"is/viewer.ftl","it":"it/viewer.ftl","ja":"ja/viewer.ftl","ka":"ka/viewer.ftl","kab":"kab/viewer.ftl","kk":"kk/viewer.ftl","km":"km/viewer.ftl","kn":"kn/viewer.ftl","ko":"ko/viewer.ftl","lij":"lij/viewer.ftl","lo":"lo/viewer.ftl","lt":"lt/viewer.ftl","ltg":"ltg/viewer.ftl","lv":"lv/viewer.ftl","meh":"meh/viewer.ftl","mk":"mk/viewer.ftl","ml":"ml/viewer.ftl","mr":"mr/viewer.ftl","ms":"ms/viewer.ftl","my":"my/viewer.ftl","nb-no":"nb-NO/viewer.ftl","ne-np":"ne-NP/viewer.ftl","nl":"nl/viewer.ftl","nn-no":"nn-NO/viewer.ftl","oc":"oc/viewer.ftl","pa-in":"pa-IN/viewer.ftl","pl":"pl/viewer.ftl","pt-br":"pt-BR/viewer.ftl","pt-pt":"pt-PT/viewer.ftl","rm":"rm/viewer.ftl","ro":"ro/viewer.ftl","ru":"ru/viewer.ftl","sat":"sat/viewer.ftl","sc":"sc/viewer.ftl","scn":"scn/viewer.ftl","sco":"sco/viewer.ftl","si":"si/viewer.ftl","sk":"sk/viewer.ftl","skr":"skr/viewer.ftl","sl":"sl/viewer.ftl","son":"son/viewer.ftl","sq":"sq/viewer.ftl","sr":"sr/viewer.ftl","sv-se":"sv-SE/viewer.ftl","szl":"szl/viewer.ftl","ta":"ta/viewer.ftl","te":"te/viewer.ftl","tg":"tg/viewer.ftl","th":"th/viewer.ftl","tl":"tl/viewer.ftl","tr":"tr/viewer.ftl","trs":"trs/viewer.ftl","uk":"uk/viewer.ftl","ur":"ur/viewer.ftl","uz":"uz/viewer.ftl","vi":"vi/viewer.ftl","wo":"wo/viewer.ftl","xh":"xh/viewer.ftl","zh-cn":"zh-CN/viewer.ftl","zh-tw":"zh-TW/viewer.ftl"}';
+export {
+  e as default
+};