Skip to content

Commit d15690f

Browse files
authored
Merge branch 'master' into master
2 parents a089249 + 1a47de9 commit d15690f

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# vue-pdf
2-
vue.js pdf viewer
2+
vue.js pdf viewer is a package for Vue that enables you to display and view PDF's easily via vue components.
33

4-
## Install
4+
## Install via NPM/Yarn
55
```bash
6-
npm install --save vue-pdf
6+
npm install vue-pdf
7+
```
8+
9+
```bash
10+
yarn add vue-pdf
711
```
812

913
## Example - basic
1014
```vue
1115
<template>
12-
<pdf src="./static/relativity.pdf"></pdf>
16+
<pdf src="./path/to/static/relativity.pdf"></pdf>
1317
</template>
1418
1519
<script>
@@ -39,13 +43,14 @@ since v2.x, the script is exported as esm.
3943
### Props
4044

4145
#### :src <sup>String / Object - default: ''<sup>
42-
The url of the pdf file. `src` may also be a `string|TypedArray|DocumentInitParameters|PDFDataRangeTransport` for more details, see [`PDFJS.getDocument()`](https://github.com/mozilla/pdf.js/blob/8ff1fbe7f819513e7d0023df961e3d223b35aefa/src/display/api.js#L117).
46+
The url of the given pdf. `src` may also be a `string|TypedArray|DocumentInitParameters|PDFDataRangeTransport` for more details, see [`PDFJS.getDocument()`](https://github.com/mozilla/pdf.js/blob/8ff1fbe7f819513e7d0023df961e3d223b35aefa/src/display/api.js#L117).
4347

4448
#### :page <sup>Number - default: 1<sup>
4549
The page number to display.
4650

4751
#### :rotate <sup>Number - default: 0<sup>
4852
The page rotation in degrees, only multiple of 90 are valid.
53+
EG: 90, 180, 270, 360, ...
4954

5055
### Events
5156

@@ -57,19 +62,19 @@ The page rotation in degrees, only multiple of 90 are valid.
5762
Document loading progress. Range [0, 1].
5863

5964
#### @loaded
60-
Triggered when the document is loaded.
65+
Triggers when the document is loaded.
6166

6267
#### @page-loaded <sup>Number<sup>
63-
Triggered when a page is loaded.
68+
Triggers when a page is loaded.
6469

6570
#### @num-pages <sup>Number<sup>
66-
The total number of pages of the pdf.
71+
The sum of all pages from the given pdf.
6772

6873
#### @error <sup>Object<sup>
69-
Triggered when an error occurred.
74+
Triggers when an error occurs.
7075

7176
#### @link-clicked <sup>Number<sup>
72-
Triggered when an internal link is clicked
77+
Triggers when an internal link is clicked
7378

7479

7580
### Public methods

src/pdfjsWrapper.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,9 @@ export default function(PDFJS) {
193193
if ( canceling )
194194
return;
195195
canceling = true;
196-
pdfRender.cancel().catch( function(err) { emit('error', err)});
196+
pdfRender.cancel().catch(function(err) {
197+
emitEvent('error', err);
198+
});
197199
return;
198200
}
199201

0 commit comments

Comments
 (0)