@syncfusion/ej2-angular-pdfviewer 20.4.38 → 20.4.40-ngcc

package/README.md

@@ -1,62 +1,172 @@
-# ej2-pdfviewer
+# Angular PDF Viewer Component
 
-Syncfusion [Angular PDF Viewer](https://www.syncfusion.com/angular-ui-components/angular-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm) control enables you to view and print PDF files from your web applications.
+The Syncfusion [Angular PDF Viewer](https://www.syncfusion.com/angular-ui-components/angular-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm) component enables you to view, annotate, prepare and fill forms, and print PDF files from your web applications.
 
-![PDF Viewer](https://ej2.syncfusion.com/products/images/pdfviewer/readme.gif)
+<p align="center">
+    <a href="https://ej2.syncfusion.com/angular/documentation/pdfviewer/getting-started/?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm">Getting started</a> .
+    <a href="https://ej2.syncfusion.com/angular/demos/?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm#/material/pdfviewer/default">Online demos</a> .
+    <a href="https://www.syncfusion.com/angular-components/angular-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm">Learn more</a>
+</p>
 
-> This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA (https://www.syncfusion.com/eula/es/). To acquire a license, you can purchase one at https://www.syncfusion.com/sales/products or start a free 30-day trial here (https://www.syncfusion.com/account/manage-trials/start-trials).
+<p align="center">
+    <img src="https://raw.githubusercontent.com/SyncfusionExamples/nuget-img/master/angular/angular-pdf-viewer.png" alt="Angular PDF Viewer Component"/>
+</p>
 
-> A free community license (https://www.syncfusion.com/products/communitylicense) is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
+<p align="center">
+Trusted by the world's leading companies
+  <a href="https://www.syncfusion.com">
+    <img src="https://raw.githubusercontent.com/SyncfusionExamples/nuget-img/master/syncfusion/syncfusion-trusted-companies.webp" alt="Bootstrap logo">
+  </a>
+</p>
 
 ## Setup
 
-To install PDF Viewer and its dependent packages, use the following command
+### Create an Angular Application
 
-```sh
-npm install @syncfusion/ej2-pdfviewer
+You can use [Angular CLI](https://github.com/angular/angular-cli) to setup your Angular applications. To install the Angular CLI, use the following command.
+
+```bash
+npm install -g @angular/cli
 ```
 
-## Resources
+Create a new Angular application using the following Angular CLI command.
 
-* [Getting Started](https://ej2.syncfusion.com/angular/documentation/pdfviewer/getting-started/?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
-* [View Online Demos](https://ej2.syncfusion.com/angular/demos/?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm#/material/pdfviewer/default)
-* [Product Page](https://www.syncfusion.com/angular-ui-components/angular-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
+```bash
+ng new my-app
+cd my-app
+```
 
-## Supported Frameworks
+### Adding Syncfusion PDF Viewer package
 
-PDF Viewer component is also offered in following list of frameworks.
+All Syncfusion Angular packages are available in [npmjs.com](https://www.npmjs.com/~syncfusionorg). To install the Angular PDF Viewer package, use the following command.
 
-1. [JavaScript PDF Viewer](https://www.syncfusion.com/javascript-ui-controls/js-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
-2. [React PDF Viewer](https://www.syncfusion.com/react-ui-components/react-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
-3. [VueJS PDF Viewer](https://www.syncfusion.com/vue-ui-components/vue-pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
-4. [ASP.NET Core PDF Viewer](https://www.syncfusion.com/aspnet-core-ui-controls/pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
-5. [ASP.NET MVC PDF Viewer](https://www.syncfusion.com/aspnet-mvc-ui-controls/pdf-viewer?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
+```bash
+ng add @syncfusion/ej2-angular-pdfviewer
+```
 
-## Key Features
+The above command does the below configuration to your Angular app.
 
-* **View PDF Document** - Open and display both normal and PDF files protected with AES and RC4 encryption.
-* **Core interactions** - Scrolling, Zooming, panning and page navigation.
-* **Built-in toolbar**  - Built-in-toolbar to perform user interaction of PDF Viewer functionalities.
-* **Selection**         - Select and copy text from PDF file.
-* **Search**            - Search a text easily across the PDF document.
-* **Navigation**        - Easy navigation with the help of Bookmarks, thumbnails, hyperlinks and table of contents.
-* **View modes**        - fit to page, fit to visible and fit to width.
-* **Print**             - Print the entire document or a specific page directly from the browser.
+* Adds `@syncfusion/ej2-angular-pdfviewer` package and its peer dependencies to your `package.json` file.
+* Imports the `PdfViewerModule` in your application module `app.module.ts`.
+* Registers the Syncfusion UI default theme (material) in the `angular.json` file.
 
-## Support
+This makes it easy to add the Syncfusion Angular PDF Viewer module to your project and start using it in your application.
+
+### Adding CSS references for PDF Viewer
+
+Add CSS references needed for a PDF Viewer in **src/styles.css** from the **../node_modules/@syncfusion** package folder.
+
+```css
+@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-lists/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
+@import '../node_modules/@syncfusion/ej2-notifications/styles/material.css';  
+@import "../node_modules/@syncfusion/ej2-angular-pdfviewer/styles/material.css";
+```
+
+### Add PDF Viewer component
+
+In **src/app/app.component.ts**, use `<ejs-pdfviewer>` selector in the `template` attribute of the `@Component` directive to render the Syncfusion Angular PDF Viewer component.
+
+```typescript
+import { Component, ViewEncapsulation, OnInit } from '@angular/core';
+import './styles.css';
+import {
+  PdfViewerComponent,
+  LinkAnnotationService,
+  BookmarkViewService,
+  MagnificationService,
+  ThumbnailViewService,
+  ToolbarService,
+  NavigationService,
+  TextSearchService,
+  TextSelectionService,
+  PrintService,
+  AnnotationService,
+  FormFieldsService,
+  FormDesignerService
+} from '@syncfusion/ej2-angular-pdfviewer';
+
+@Component({
+  selector: 'app-root',
+  template: `<div class="content-wrapper">
+    <ejs-pdfviewer id="pdfViewer"
+              [serviceUrl]='service'
+              [documentPath]='document'
+              style="height:640px;display:block">
+    </ejs-pdfviewer>
+  </div>`,
+  encapsulation: ViewEncapsulation.None,
+  providers: [
+    LinkAnnotationService,
+    BookmarkViewService,
+    MagnificationService,
+    ThumbnailViewService,
+    ToolbarService,
+    NavigationService,
+    TextSearchService,
+    TextSelectionService,
+    PrintService,
+    AnnotationService,
+    FormFieldsService,
+    FormDesignerService
+  ],
+})
+export class AppComponent implements OnInit {
+  public service: string =
+    'https://ej2services.syncfusion.com/production/web-services/api/pdfviewer';
+  public document: string = 'PDF_Succinctly.pdf';
+  ngOnInit(): void {
+  }
+}
+```
 
-Product support is available for through following mediums.
+## Supported frameworks
 
-* Creating incident in Syncfusion [Direct-trac](https://www.syncfusion.com/support/directtrac/incidents?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm) support system or [Community forum](https://www.syncfusion.com/forums/essential-js2?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm).
-* New [GitHub issue](https://github.com/syncfusion/ej2-pdfviewer/issues/new?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm).
-* Ask your query in Stack Overflow with tag `syncfusion`, `ej2`.
+PDF Viewer component is also offered in the following list of frameworks.
 
-## License
+| [<img src="https://ej2.syncfusion.com/github/images/js.svg" height="50" />](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github)<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JavaScript](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github)&nbsp;&nbsp;&nbsp;&nbsp; | [<img src="https://ej2.syncfusion.com/github/images/react.svg"  height="50" />](https://www.syncfusion.com/react-ui-components?utm_medium=listing&utm_source=github)<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[React](https://www.syncfusion.com/react-ui-components?utm_medium=listing&utm_source=github)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | [<img src="https://ej2.syncfusion.com/github/images/vue.svg" height="50" />](https://www.syncfusion.com/vue-ui-components?utm_medium=listing&utm_source=github)<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Vue](https://www.syncfusion.com/vue-ui-components?utm_medium=listing&utm_source=github)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | [<img src="https://ej2.syncfusion.com/github/images/netcore.svg" height="50" />](https://www.syncfusion.com/aspnet-core-ui-controls?utm_medium=listing&utm_source=github)<br/>&nbsp;&nbsp;[ASP.NET&nbsp;Core](https://www.syncfusion.com/aspnet-core-ui-controls?utm_medium=listing&utm_source=github)&nbsp;&nbsp; | [<img src="https://ej2.syncfusion.com/github/images/netmvc.svg" height="50" />](https://www.syncfusion.com/aspnet-mvc-ui-controls?utm_medium=listing&utm_source=github)<br/>&nbsp;&nbsp;[ASP.NET&nbsp;MVC](https://www.syncfusion.com/aspnet-mvc-ui-controls?utm_medium=listing&utm_source=github)&nbsp;&nbsp; |
+| :-----: | :-----: | :-----: | :-----: | :-----: |
 
-Check the license detail [here](https://github.com/syncfusion/ej2/blob/master/license?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm).
+## Key features
+
+* [View PDF Document](https://ej2.syncfusion.com/angular/documentation/pdfviewer/getting-started/) - Open and display both the normal and the protected PDF files with AES and RC4 encryption.
+* [Annotations](https://ej2.syncfusion.com/angular/documentation/pdfviewer/annotation/text-markup-annotation/) - Annotate with text markup, shapes, stamps, ink, and sticky notes.
+* [Form Fields](https://ej2.syncfusion.com/angular/documentation/pdfviewer/form-designer/create-fillable-PDF-forms/create-programmatically/) - Form filling and form designing can be done.
+* [Signature](https://ej2.syncfusion.com/angular/documentation/pdfviewer/handwritten-signature/) - Hand-written and digital signatures are allowed.
+* [Toolbar](https://ej2.syncfusion.com/angular/documentation/pdfviewer/toolbar/) - Built-in-toolbar and custom toolbars to perform user interaction of PDF Viewer functionalities.
+* [Navigation](https://ej2.syncfusion.com/angular/documentation/pdfviewer/navigation/) - Easy navigation with the help of bookmarks, thumbnails, hyperlinks, and table of contents.
+* [Magnification](https://ej2.syncfusion.com/angular/documentation/pdfviewer/magnification/) - Fit to page, fit to width, and automatic (fits to the visible area).
+* [Search](https://ej2.syncfusion.com/angular/documentation/pdfviewer/text_search/) - Search a text easily across the PDF document.	
+* [Core Interactions](https://ej2.syncfusion.com/angular/documentation/pdfviewer/interaction_mode/) - Allows scrolling, zooming, panning, selection, and page navigation.
+* [Print](https://ej2.syncfusion.com/angular/documentation/pdfviewer/print/) - Print the entire document or a specific page directly from the browser.
+* [Globalization](https://ej2.syncfusion.com/angular/documentation/pdfviewer/globalization/) - Provides inherent support to localize the UI.
+
+## Support
+
+Product support is available through the following mediums.
+
+* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
+* [Community forum](https://www.syncfusion.com/forums/angular-js2?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
+* [GitHub issues](https://github.com/syncfusion/ej2-angular-ui-components/issues/new)
+* [Request feature or report bug](https://www.syncfusion.com/feedback/angular?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
+* Live chat
 
 ## Changelog
 
-Check the changelog [here](https://github.com/syncfusion/ej2-pdfviewer/blob/master/CHANGELOG.md?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm)
+Check the changelog [here](https://github.com/syncfusion/ej2-pdfviewer/blob/master/CHANGELOG.md?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm). Get minor improvements and bug fixes every week to stay up to date with frequent updates.
+
+## License and copyright
+
+> This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's [EULA](https://www.syncfusion.com/eula/es/). To acquire a license for 80+ [Angular UI components](https://www.syncfusion.com/angular-components), you can [purchase](https://www.syncfusion.com/sales/products) or [start a free 30-day trial](https://www.syncfusion.com/account/manage-trials/start-trials).
+
+> A free community [license](https://www.syncfusion.com/products/communitylicense) is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
+
+See [LICENSE FILE](https://github.com/syncfusion/ej2/blob/master/license?utm_source=npm&utm_medium=listing&utm_campaign=angular-pdf-viewer-npm) for more info.
 
- © Copyright 2022 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.
+&copy; Copyright 2022 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.