Skip to content

Commit c44ae51

Browse files
committed
Fix readme
1 parent 2fc254f commit c44ae51

File tree

3 files changed

+36
-25
lines changed

3 files changed

+36
-25
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,34 @@ A web component for viewing pdf files in the browser. The package is based on [P
88
⚠️ `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).
99

1010
## Install
11-
```
12-
npm install --save pdfjs-viewer-element
13-
```
1411

15-
```
12+
Using module bundlers:
13+
14+
```bash
15+
# With npm
16+
npm install pdfjs-viewer-element
17+
# With yarn
1618
yarn add pdfjs-viewer-element
1719
```
1820

19-
or
20-
21+
```javascript
22+
import 'pdfjs-viewer-element'
2123
```
24+
25+
Using browser:
26+
27+
```html
2228
<script type="module" src="https://cdn.skypack.dev/pdfjs-viewer-element"></script>
2329
```
2430

2531
## Usage
2632

27-
Place **PDF.js prebuilt** files to some directory of your project (`pdfjs` used as the standard name). See demo [example](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/public). You may call the directory as you want, but then you should specify the `viewer-path` property.
28-
29-
```javascript
30-
import 'pdfjs-viewer-element'
31-
```
32-
33-
```javascript
33+
```html
3434
<pdfjs-viewer-element src="/file.pdf" viewer-path="/path-to-viewer"></pdfjs-viewer-element>
3535
```
3636

3737
## Properties
3838

39-
`src` - path to pdf file.
40-
41-
`viewer-path` - path to prebuilt directory (`/pdfjs` by default).
42-
4339
`src` - Path to pdf file
4440

4541
`viewer-path` - Path to PDF.js prebuilt
@@ -56,6 +52,8 @@ import 'pdfjs-viewer-element'
5652

5753
`pagemode` - Page mode
5854

55+
For more clarity, see the [demo playground](https://alekswebnet.github.io/pdfjs-viewer-element/api).
56+
5957
## License
6058
For this package - [MIT](http://opensource.org/licenses/MIT).
6159

types/debounce.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export declare const debounce: (fn: Function, ms?: number) => (this: any, ...args: any[]) => void;

types/pdfjs-viewer-element.d.ts

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
export declare class PdfjsViewerElement extends HTMLElement {
2-
constructor();
3-
static get observedAttributes(): string[];
4-
connectedCallback(): void;
5-
attributeChangedCallback(name: string): void;
6-
updateIframe(): void;
2+
constructor();
3+
private iframe;
4+
static get observedAttributes(): string[];
5+
connectedCallback(): void;
6+
attributeChangedCallback(): void;
7+
private onAttrsChanged;
8+
private setProps;
9+
private setEventListeners;
10+
private getFileSrc;
711
}
812
declare global {
9-
interface Window {
10-
PdfjsViewerElement: typeof PdfjsViewerElement;
11-
}
13+
interface Window {
14+
PdfjsViewerElement: typeof PdfjsViewerElement;
15+
}
16+
}
17+
export interface PdfjsViewerElementIframeWindow extends Window {
18+
PDFViewerApplicationOptions: {
19+
set: (name: string, value: string | boolean) => void;
20+
};
21+
}
22+
export interface PdfjsViewerElementIframe extends HTMLIFrameElement {
23+
contentWindow: PdfjsViewerElementIframeWindow;
1224
}
1325
export default PdfjsViewerElement;

0 commit comments

Comments
 (0)