ngx-doc-viewer
v15.0.1
Published
Angular document viewer.
Downloads
142,283
Readme
ngx-doc-viewer
This component can be used to show several different document types in an Angular app.
Documents that are publicly available can be shown in an iframe using the google or office document viewer.
Pdf files and word document that are not publicly available can be shown using the mammoth viewer or pdf viewer by passing an objectUrl.
View demo
Changes
Install the NPM Module
npm install ngx-doc-viewer --save
Usage
1. Import NgxDocViewerModule
@NgModule({
imports: [NgxDocViewerModule],
})
export class AppModule {}
2. Add DocViewer to component:
<ngx-doc-viewer
[url]="doc"
viewer="google"
style="width:100%;height:50vh;"
></ngx-doc-viewer>
To
API:
Input:
- url: document url.
- viewer: google (default), office, mammoth, pdf or url
- viewerUrl: only for viewer: 'url'; location of the document renderer. Only use this option for other viewers then google or office.
- queryParams, e.g. to set language. for google: hl=[lang] e.g. hl=nl
- disableContent: 'none' | 'all' | 'popout' | 'popout-hide' = 'none':
- none: no overlay
- all: adds an overlay to the whole iframe, which makes nothing in the document clickable/selectable
- popout: adds an overlay over googles popout button or office popout and menu which disables just this button/menu but keeps giving the possibility to select text. The popout button is still visible (for google during a few seconds) but not clickable.
- popout-hide: see popup, instead of an transparent overlay a white one. This really hides the button but you'll see a white block while loading for the google viewer.
- overrideLocalhost: documents from the assets folder are not publicly available and therefor won't show in an external viewer (google, office). If the site is already published to public server, then pass that url and if will replace localhost by the other url. Like: overrideLocalhost="https://angular-doc-viewer.firebaseapp.com/"
There are some issues loading document in the google viewer. See: https://stackoverflow.com/questions/40414039/google-docs-viewer-returning-204-responses-no-longer-working-alternatives. If loading pdf's and Word documents, seems to work now with this hack let me know via a Github issue.
googleCheckContentLoaded = true | If true it will check by interval if the content is loaded.
googleCheckInterval = 3000 | The interval in milliseconds that is checked whether the iframe is loaded.
googleMaxChecks = 5 | max number of retries Output:
loaded: google only, notifies when iframe is loaded. Can be used to show progress while loading
File type support
office viewer
.ppt, .pptx, .doc, .docx, .xls and .xlsx
google viewer
Only files under 25 MB can be previewed with the Google Drive viewer.
Google Drive viewer helps you preview over 15 different file types, listed below:
- Text files (.TXT)
- Markup/Code (.CSS, .HTML, .PHP, .C, .CPP, .H, .HPP, .JS)
- Microsoft Word (.DOC and .DOCX)
- Microsoft Excel (.XLS and .XLSX)
- Microsoft PowerPoint (.PPT and .PPTX)
- Adobe Portable Document Format (.PDF)
- Apple Pages (.PAGES)
- Adobe Illustrator (.AI)
- Adobe Photoshop (.PSD)
- Tagged Image File Format (.TIFF)
- Autodesk AutoCad (.DXF)
- Scalable Vector Graphics (.SVG)
- PostScript (.EPS, .PS)
- TrueType (.TTF)
- XML Paper Specification (.XPS)
- Archive file types (.ZIP and .RAR)
Source
url
For another external document viewers that should be loaded in an iframe.
For Google Drive
<ngx-doc-viewer
[url]="'https://drive.google.com/file/d/0B5ImRpiNhCfGZDVhMGEyYmUtZTdmMy00YWEyLWEyMTQtN2E2YzM3MDg3MTZh/preview'"
viewer="url"
style="width:100%;height:50vh;"
>
</ngx-doc-viewer>
For the Google Viewer or any other viewer where there is a base url and a parameter for the documentUrl:
<ngx-doc-viewer
[viewerUrl]="https://docs.google.com/gview?url=%URL%&embedded=true"
[url]="https://file-examples.com/wp-content/uploads/2017/02/file-sample_100kB.doc"
viewer="url"
style="width:100%;height:50vh;"
>
</ngx-doc-viewer>
NOTE: PDF's are shown in the embed tag. Browser support is not guaranteed. If you need to be sure the pdf renders on all browsers you better use PDF.js
mammoth
.docx
To use mammoth, also add:
npm install mammoth --save
and make sure mammoth.browser.min.js is loaded. For the angular/cli you would add the following in angular.json:
"scripts": [
"node_modules/mammoth/mammoth.browser.min.js"
]