alfresco-ng2-components/docs/core/viewer.component.md

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-03-07

Viewer component

Displays content from an ACS repository.

See it live: Viewer Quickstart

Contents

• Basic usage

  • Properties
  • Events
  • Keyboard shortcuts

• Details

  • Integrating with the Document List component
  • Custom file parameters
  • Supported file formats
  • Content Renditions
  • Configuring PDF.js library
  • Custom toolbar
  • Custom toolbar buttons
  • Custom sidebar
  • Custom thumbnails
  • Custom "Open With" menu
  • Custom "More actions" menu
  • Extending the Viewer

• See also

Basic usage

Using with node id:

<adf-viewer 
    [showViewer]="true" 
    [overlayMode]="true" 
    [fileNodeId]="'d367023a-7ebe-4f3a-a7d0-4f27c43f1045'">
</adf-viewer>

Using with file url:

<adf-viewer 
    [overlayMode]="true" 
    [urlFile]="'filename.pdf'">
</adf-viewer>

Properties

Name	Type	Default value	Description
urlFile	string	''	If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from.
urlFileViewer	string	null	Viewer to use with the urlFile address (pdf, image, media, text). Used when urlFile has no filename and extension.
blobFile	Blob		Loads a Blob File
fileNodeId	string	null	Node Id of the file to load.
sharedLinkId	string	null	Shared link id (to display shared file).
overlayMode	boolean	false	If true then show the Viewer as a full page over the current content. Otherwise fit inside the parent div.
showViewer	boolean	true	Hide or show the viewer
showToolbar	boolean	true	Hide or show the toolbar
displayName	string		Specifies the name of the file when it is not available from the URL.
allowGoBack	boolean	true	Allows back navigation
allowDownload	boolean	true	Toggles downloading.
allowPrint	boolean	false	Toggles printing.
allowShare	boolean	false	Toggles sharing.
allowFullScreen	boolean	true	Toggles the 'Full Screen' feature.
allowNavigate	boolean	false	Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection.
canNavigateBefore	boolean	true	Toggles the "before" ("<") button. Requires allowNavigate to be enabled.
canNavigateNext	boolean	true	Toggles the next (">") button. Requires allowNavigate to be enabled.
allowSidebar	boolean	false	Toggles the sidebar.
allowThumbnails	boolean	true	Toggles PDF thumbnails.
showSidebar	boolean	false	Toggles sidebar visibility. Requires allowSidebar to be set to true.
sidebarPosition	string	'right'	The position of the sidebar. Can be left or right.
sidebarTemplate	TemplateRef<any>	null	The template for the sidebar. The template context contains the loaded node data.
thumbnailsTemplate	TemplateRef<any>	null	The template for the pdf thumbnails.
mimeType	string		MIME type of the file content (when not determined by the filename extension).
fileName	string		Content filename.
downloadUrl	string	null	URL to download.
maxRetries	number	5	Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts.

Events

Name	Type	Description
goBack	EventEmitter<BaseEvent<any>>	Emitted when user clicks the 'Back' button.
download	EventEmitter<BaseEvent<any>>	Emitted when user clicks the 'Download' button.
print	EventEmitter<BaseEvent<any>>	Emitted when user clicks the 'Print' button.
share	EventEmitter<BaseEvent<any>>	Emitted when user clicks the 'Share' button.
showViewerChange	EventEmitter<boolean>	Emitted when the viewer is shown or hidden.
extensionChange	EventEmitter<string>	Emitted when the filename extension changes.
navigateBefore	EventEmitter<{}>	Emitted when user clicks 'Navigate Before' ("<") button.
navigateNext	EventEmitter<{}>	Emitted when user clicks 'Navigate Next' (">") button.

Keyboard shortcuts

Name	Description
Esc	Close the viewer (overlay mode only).
Left	Invoke 'Navigate before' action.
Right	Invoke 'Navigate next' action.
Ctrl+F	Activate full-screen mode.

Details

Integrating with the Document List component

Below is the most simple integration of the Viewer and Document List components within your custom component:

<adf-document-list
    currentFolderId="-my-"
    (preview)="showPreview($event)">
</adf-document-list>

<adf-viewer
    [(showViewer)]="showViewer"
    [overlayMode]="true"
    [fileNodeId]="nodeId">
</adf-viewer>

The component controller class implementation might look like the following:

export class OverlayViewerComponent {

    @Input()
    showViewer: boolean = false;

    nodeId: string;

    showPreview(event) {
        if (event.value.entry.isFile) {
            this.nodeId = event.value.entry.id;
            this.showViewer = true;
        }
    }
}

Custom file parameters

You can provide custom file parameters, for example a value for the mimeType or displayName when using URL values that have no file names or extensions:

<adf-viewer
    [displayName]="fileName"
    [allowGoBack]="false"
    [mimeType]="mimeType"
    [urlFile]="fileUrl">
</adf-viewer>

Supported file formats

The Viewer component consists of separate Views that handle particular types of type families based on either a file extension or a mime type:

• PDF View
  • application/pdf
  • *.pdf
• Image View
  • image/png
  • image/jpeg
  • image/gif
  • image/bmp
  • image/svg+xml
  • *.png
  • *.jpg
  • *.jpeg
  • *.gif
  • *.bpm
  • *.svg
• Text View
  • text/plain
  • text/csv
  • text/xml
  • text/html
  • application/x-javascript
  • *.txt
  • *.xml
  • *.js
  • *.html
  • *.json
  • *.ts
• Media View
  • video/mp4
  • video/webm
  • video/ogg
  • audio/mpeg
  • audio/ogg
  • audio/wav
  • *.wav
  • *.mp4
  • *.mp3
  • *.webm
  • *.ogg

Content Renditions

For those extensions and mime types that cannot be natively displayed in the browser, the Viewer will try to fetch the corresponding rendition using the renditions service api.

For the full list of supported types please refer to: File types that support preview and thumbnail generation.

Configuring PDF.js library

Configure your webpack-enabled application with the PDF.js library as follows.

1. Install pdfjs-dist

npm install pdfjs-dist

2. Update vendors.ts by appending the following code. This will enable the viewer component and compatibility mode for all browsers. It will also configure the web worker for the PDF.js library to render PDF files in the background:

// PDF.js
require('pdfjs-dist/web/compatibility.js');
const pdfjsLib = require('pdfjs-dist');
pdfjsLib.PDFJS.workerSrc = './pdf.worker.js';
require('pdfjs-dist/web/pdf_viewer.js');

3. Update the plugins section of the webpack.common.js file with the following lines:

new CopyWebpackPlugin([
    ...
    {
        from: 'node_modules/pdfjs-dist/build/pdf.worker.js',
        to: 'pdf.worker.js'
    }
])

The Viewer component now should be able to display PDF files.

Custom toolbar

You can replace the standard viewer toolbar with your own custom implementation:

<adf-viewer>
    <adf-viewer-toolbar>
        <h1>toolbar</h1>
    </adf-viewer-toolbar>
</adf-viewer>

Everything you put inside the "adf-viewer-toolbar" tags will be rendered instead of the standard toolbar.

Custom toolbar buttons

If you are happy with the custom toolbar's behaviour but want to add some extra buttons then you can do so as shown in the following example:

<adf-viewer>
    <adf-viewer-toolbar-actions>
        <button mat-icon-button>
            <mat-icon>alarm</mat-icon>
        </button>
        <button mat-icon-button>
            <mat-icon>backup</mat-icon>
        </button>
        <button mat-icon-button>
            <mat-icon>bug_report</mat-icon>
        </button>
    </adf-viewer-toolbar-actions>
</adf-viewer>

The result should look like this:

Custom sidebar

The Viewer component also supports custom sidebar components and layouts. Set the allowSidebar property to true to enable this feature.

The custom sidebar can be injected in two different ways:

• using transclusion
• using a template (only works when using the viewer with fileNodeId)

Using transclusion

<adf-viewer [allowSidebar]="true">
    <adf-viewer-sidebar>
        <h1>My info</h1>
    </adf-viewer-sidebar>
</adf-viewer>

Everything you put inside the "adf-viewer-sidebar" tags will be rendered.

Using template injection (only works when using the viewer with fileNodeId)

<ng-template let-node="node" #sidebarTemplate>
    <adf-content-metadata-card [node]="node"></adf-content-metadata-card>
</ng-template>
<adf-viewer [allowSidebar]="true" [sidebarTemplate]="sidebarTemplate"></adf-viewer>

Custom thumbnails

The PDF viewer comes with its own default list of thumbnails but you can replace this by providing a custom template and binding to the context property viewer to access the PDFJS.PDFViewer instance.

Using template injection

import { Component, Input } from '@angular/core';

@Component({
    selector: 'custom-thumbnails',
    template: '<p> Custom Thumbnails Component </p>'
})
export class CustomThumbnailsComponent {
    @Input() pdfViewer: any;

    ...
}

<ng-template #customThumbnailsTemplate let-pdfViewer="viewer">
    <custom-thumbnails [pdfViewer]="pdfViewer"></custom-thumbnails>
</ng-template>

<adf-viewer [thumbnailsTemplate]="customThumbnailsTemplate"></adf-viewer>

Custom "Open With" menu

You can enable a custom "Open With" menu by providing at least one action inside the adf-viewer-open-with tag:

<adf-viewer [fileNodeId]="nodeId">

    <adf-viewer-open-with>
        <button mat-menu-item>
            <mat-icon>dialpad</mat-icon>
            <span>Option 1</span>
        </button>
        <button mat-menu-item disabled>
            <mat-icon>voicemail</mat-icon>
            <span>Option 2</span>
        </button>
        <button mat-menu-item>
            <mat-icon>notifications_off</mat-icon>
            <span>Option 3</span>
        </button>
    </adf-viewer-open-with>

</adf-viewer>

Custom "More actions" menu

You can enable a custom "More actions" menu by providing at least one action inside the adf-viewer-more-actions tag:

<adf-viewer [fileNodeId]="nodeId">

    <adf-viewer-more-actions>
        <button mat-menu-item>
            <mat-icon>dialpad</mat-icon>
            <span>Action One</span>
        </button>
        <button mat-menu-item disabled>
            <mat-icon>voicemail</mat-icon>
            <span>Action Two</span>
        </button>
        <button mat-menu-item>
            <mat-icon>notifications_off</mat-icon>
            <span>Action Three</span>
        </button>
    </adf-viewer-more-actions>

</adv-viewer>

Extending the Viewer

You can define your own custom handle to handle other file formats that are not yet supported by the Viewer component. Below is an example that shows how to use the adf-viewer-extension to handle 3D data files:

<adf-viewer [fileNodeId]="fileNodeId">
    
    <adf-viewer-extension [supportedExtensions]="['obj','3ds']" #extension>
        <ng-template let-urlFileContent="urlFileContent" let-extension="extension">
            <threed-viewer 
                [urlFile]="urlFileContent" 
                [extension]="extension">
            </threed-viewer>
        </ng-template>
    </adf-viewer-extension>

</adf-viewer> 

Note: you need to add the ng2-3d-editor dependency to your package.json file to make the example above work.

You can define multiple adf-viewer-extension templates if required:

<adf-viewer [fileNodeId]="fileNodeId">

    <adf-viewer-extension [supportedExtensions]="['xls','xlsx']" #extension>
        <ng-template let-urlFileContent="urlFileContent">
            <my-custom-xls-component 
                urlFileContent="urlFileContent">
            </my-custom-xls-component>
        </ng-template>
    </adf-viewer-extension>

    <adf-viewer-extension [supportedExtensions]="['txt']" #extension>
        <ng-template let-urlFileContent="urlFileContent" >               
            <my-custom-txt-component 
                urlFileContent="urlFileContent">
            </my-custom-txt-component>
        </ng-template>
    </adf-viewer-extension>
</adf-viewer> 

See also

• Document List component