pdfjs-viewer-element 0.0.6 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +29 -4
  2. package/package.json +17 -2
package/README.md CHANGED
@@ -1,8 +1,33 @@
1
1
  # pdfjs-viewer-element
2
2
 
3
- Implements webcomponent with [PDF.js viewer](https://mozilla.github.io/pdf.js/web/viewer.html).
3
+ Simple webcomponent for [PDF.js viewer](https://mozilla.github.io/pdf.js/web/viewer.html).
4
+
5
+ ⚠️ `pdfjs-viewer-element` uses PDF.js [prebuilt](https://github.com/mozilla/pdf.js/releases/download/v2.15.349/pdfjs-2.15.349-dist.zip), that includes the generic build of PDF.js and the viewer. To use the package you should to **extract the prebuilt** file into a public directory of your project.
4
6
 
5
7
  ## Install
6
- ...
7
- ## Properties
8
- ...
8
+ ```
9
+ npm install --save pdfjs-viewer-element
10
+ ```
11
+
12
+ or
13
+
14
+ ```
15
+ yarn add pdfjs-viewer-element
16
+ ```
17
+
18
+ ## Usage
19
+ Import to your project:
20
+
21
+ ```javascript
22
+ import 'pdfjs-viewer-element'
23
+ ```
24
+
25
+ Extract the PDF.js prebuilt. See [example](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/public).
26
+
27
+ And pass a `src` property:
28
+
29
+ ```javascript
30
+ <pdfjs-viewer-element src="/compressed.tracemonkey-pldi-09.pdf"></pdfjs-viewer-element>
31
+ ```
32
+
33
+
package/package.json CHANGED
@@ -1,7 +1,17 @@
1
1
  {
2
2
  "name": "pdfjs-viewer-element",
3
- "version": "0.0.6",
4
- "license": "UNLICENSED",
3
+ "version": "1.0.0",
4
+ "license": "MIT",
5
+ "author": {
6
+ "name": "Oleksandr Shevchuk",
7
+ "email": "alekswebnet@gmail.com"
8
+ },
9
+ "keywords": [
10
+ "pdf",
11
+ "pdf viewer",
12
+ "pdfjs",
13
+ "webcomponent"
14
+ ],
5
15
  "type": "module",
6
16
  "main": "./dist/my-lib.umd.cjs",
7
17
  "module": "./dist/my-lib.js",
@@ -11,6 +21,11 @@
11
21
  "require": "./dist/pdfjs-viewer-element.umd.cjs"
12
22
  }
13
23
  },
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "git+https://github.com/alekswebnet/pdfjs-viewer-element.git"
27
+ },
28
+ "homepage": "https://github.com/alekswebnet/pdfjs-viewer-element#readme",
14
29
  "types": "types/pdfjs-viewer-element.d.ts",
15
30
  "files": [
16
31
  "dist",