ngx-extended-pdf-viewer - npm Package Compare versions

Comparing version 0.0.3 to 0.1.0

lib/ngx-extended-pdf-viewer.component.d.ts

		@@ -1,5 +0,9 @@
		import { OnInit } from '@angular/core';
		export declare class NgxExtendedPdfViewerComponent implements OnInit {
		import { OnInit, OnChanges, SimpleChanges } from '@angular/core';
		export declare class NgxExtendedPdfViewerComponent implements OnInit, OnChanges {
		private _src;
		private initialized;
		src: string;
		constructor();
		ngOnInit(): void;
		ngOnChanges(changes: SimpleChanges): void;
		}

package.json

		{
		"name": "ngx-extended-pdf-viewer",
		"version": "0.0.3",
		"version": "0.1.0",
		"license": "Apache License V2",
		@@ -5,0 +5,0 @@ "repository": {

README.md

		# ngx-extended-pdf-viewer

		When this project is finished (or what passes as "finished" in the IT world), it'll be an embeddable
		This library provides an embeddable
		PDF viewer component. It's different from other approaches like ng2-pdf-viewer in that it
		provides the full suite of UI widgets. In other words, it looks exactly like the PDF viewer of the browser.
		shows the full suite of UI widgets. In other words, it looks exactly like the PDF viewer of the browser.

		## State of the art

		Currently, this is only a preliminary version of the library. It works, but it requires some ugly
		workarounds and it's not really embeddable: The CSS file used by the library affects the entire
		application.
		The library is very young, but it _should_ already be useful. Use at own risk.

		Please come back in a couple of days, when the problems are - hopefully - solved!
		The library has been developed with Angular 6, so probably npm will complain if you're using
		an older version of Angular. In theory, ngx-extended-pdf-viewer should be compatible with
		every Angular version since 2.0, but that hasn't been tested yet.

		## How to use the library

		There's a minimalistic demo project at https://github.com/stephanrauh/ExploringAngular/embedding-pdf.

		1. Install the library with npm i ngx-extended-pdf-viewer --save
		@@ -26,5 +28,20 @@ 2. Open the file "angular.json" (or ".angular-cli.json" if you're using an older version of Angular)

		3. Add "NgxExtendedPdfViewerModule" to the module file.
		4. Now you can display the PDF file using "<ngx-extended-pdf-viewer></ngx-extended-pdf-viewer>".
		3. Add "NgxExtendedPdfViewerModule" to the import section of your module file. If you IDE doesn't find
		the import automatically, here it is:

		import { NgxExtendedPdfViewerModule } from 'ngx-extended-pdf-viewer';

		4. Now you can display the PDF file using "<ngx-extended-pdf-viewer src="'assets/example.pdf'"></ngx-extended-pdf-viewer>".

		## Configuration

		Currently, the library is in a very early stage, so there's almost nothing to configure.

		src defines the URL of the PDF file to display.

		## Feedback, pull requests and bug reports

		Pull requests and bug reports are welcome. Please send them to the bug tracker of
		the project page: https://github.com/stephanrauh/ngx-extended-pdf-viewer

		## License and Kudos
		@@ -35,4 +52,4 @@
		https://github.com/mozilla/pdf.js, which has been published under an Apache V2 license
		https://github.com/legalthings/pdf.js-viewer, which has also been published unde an Apache V2 license.
		https://github.com/legalthings/pdf.js-viewer, which has also been published under an Apache V2 license.

		Hence the licence of the ngx-extended-pdf-viewer is the Apache V2 license, too.

bundles/ngx-extended-pdf-viewer.umd.js