pdfjs-viewer-element 2.3.2 → 2.4.0

package/README.md

@@ -1,8 +1,10 @@
 # pdfjs-viewer-element
 
-A web component for viewing pdf files in the browser. The package is based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html) build and works with any framework.
+A custom element, based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html). Supported in all [major browsers](https://caniuse.com/custom-elementsv1) and works with most [JS frameworks](https://custom-elements-everywhere.com/). See [examples](https://alekswebnet.github.io/pdfjs-viewer-element/#demo) of usage in the different frameworks.
 
-⚠️ `pdfjs-viewer-element` uses PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/), that includes the generic build of PDF.js and the viewer. To use the package you should download and **place the prebuilt** files to some directory of your project. Then specify the path to this directory with `viewer-path` property (`/pdfjs` by default).
+⚠️ `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. To use the package you should [download](http://mozilla.github.io/pdf.js/getting_started/) and **place the prebuilt** files to some directory of your project. Then specify the path to this directory with `viewer-path` property (`/pdfjs` by default).
+
+You have full access to PDF.js viewer application using `initialize` method. 
 
 ## Status
 
@@ -47,11 +49,11 @@ Using browser:
 
 ## Properties
 
-`src` - Path to pdf file
+`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
+`viewer-path` - Path to PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/)
 
-`locale` - Language of the interface, see [all l10n files](https://github.com/mozilla/pdf.js/tree/master/l10n)
+`locale` -  Specifies which language to use in the viewer UI. For a list of the available locales, see [all l10n files](https://github.com/mozilla/pdf.js/tree/master/l10n)
 
 `text-layer` - Text layer, that is used for text selection
 
@@ -67,7 +69,19 @@ Using browser:
 
 For more clarity, see the [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
 
-## License
-For this package - [MIT](http://opensource.org/licenses/MIT).
+## PDF.js Viewer Application
 
-For the `pdf.js` library - https://github.com/mozilla/pdf.js/blob/master/LICENSE.
+`initialize` - using this method you can access PDFViewerApplication and use methods and events of PDF.js default viewer
+
+```javascript
+document.addEventListener('DOMContentLoaded', async () => {
+  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(pdfData)
+})
+```
+
+## License
+[MIT](http://opensource.org/licenses/MIT)