mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-02 17:53:30 +00:00

Files

T

Vito Albano 9fe4006a0d AAE-45391 Lazy loading and improvements for pdfJS (#11869 )

* [AAE-45391] - Lazy loading some of the big external libs

* [AAE-45391] - Added some extra units to pdfjs viewer

* [AAE-45391] - Some improement on viewer component

* [AAE-45391] - Fixed the way it was redered to a newer angular system

* [AAE-45391] - Fixed the way it was redered to a newer angular system

* [AAE-45391] - fixed schematic

* [AAE-45391] - Added some docs for the schematics as well

* [AAE-37328] - Fixed comment on missing provider

2026-05-11 14:17:39 +01:00

2.6 KiB

Raw Permalink Blame History

@alfresco/adf-core/viewer/pdf

Secondary entrypoint that provides the PDF viewer component, extracted from @alfresco/adf-core to make pdfjs-dist an optional dependency.

Setup

Install pdfjs-dist (if not already present):

npm install pdfjs-dist

Add providePdfViewer() to your app providers:

import { providePdfViewer } from '@alfresco/adf-core/viewer/pdf';

// Standalone app (app.config.ts)
export const appConfig: ApplicationConfig = {
    providers: [
        providePdfViewer(),
        // ...other providers
    ]
};

// NgModule-based app (app.module.ts)
@NgModule({
    providers: [providePdfViewer()]
})
export class AppModule {}

That's it. The viewer will render PDFs using the real PdfViewerComponent.

Migration from v8.x

If upgrading from a version where PdfViewerComponent was part of @alfresco/adf-core directly, run:

ng update @alfresco/adf-core

The migration schematic will:

Rewrite imports of PDF symbols (PdfViewerComponent, PdfPasswordDialogComponent, PdfThumbListComponent, PdfThumbComponent, PDFJS_MODULE, PDFJS_VIEWER_MODULE, RenderingQueueServices) from @alfresco/adf-core to @alfresco/adf-core/viewer/pdf
Add providePdfViewer() to your app's providers array

Opting out of PDF support

If your application does not need to render PDFs, you can skip installing pdfjs-dist and omit providePdfViewer(). The viewer will display an "unknown format" placeholder for PDF files.

Exports

Symbol	Description
`providePdfViewer()`	Provider function that registers the PDF viewer
`PdfViewerComponent`	The PDF viewer component
`PdfPasswordDialogComponent`	Password dialog for protected PDFs
`PdfThumbListComponent`	PDF thumbnail list
`PdfThumbComponent`	Individual PDF thumbnail
`PDFJS_MODULE`	Injection token for pdfjs-dist library
`PDFJS_VIEWER_MODULE`	Injection token for pdfjs viewer module
`RenderingQueueServices`	Service managing PDF page render queue

Architecture

@alfresco/adf-core (primary entrypoint)
  - Exports: PDF_VIEWER_COMPONENT token, PdfViewerRef interface
  - ViewerRenderComponent injects the token via NgComponentOutlet
  - Does NOT depend on pdfjs-dist

@alfresco/adf-core/viewer/pdf (this entrypoint)
  - Imports from: @alfresco/adf-core, pdfjs-dist
  - Exports: PdfViewerComponent, providePdfViewer(), etc.

The dependency is one-way (secondary -> primary). The primary entrypoint never imports from this package, avoiding circular dependencies and keeping pdfjs-dist out of the main bundle.

2.6 KiB Raw Permalink Blame History