alfresco-ng2-components/ng2-components/ng2-alfresco-documentlist/README.md

DocumentList Component

• Prerequisites
• See also
• Install
• Document List
  • Properties
  • Events
  • DOM Events
  • Handling DOM events
  • Setting default folder
• Calling DocumentList api directly
• Breadcrumb Component
  • Properties
  • Events
• Menu Actions
• Custom columns
  • DataColumn Properties
• Column definition
  • Column Template
  • Actions
    • Menu actions
    • Default action handlers
      • Delete - Show notification message with no permission
      • Delete - Disable button checking the permission
      • Download
    • Folder actions
  • Context Menu
  • Navigation mode
  • Events
• Advanced usage and customization
  • Custom row filter
  • Custom image resolver
  • Hiding columns on small screens
  • Custom 'empty folder' template
  • Customizing default actions
• Build from sources
• NPM scripts
• Demo
• License

Prerequisites

Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration prerequisites.

If you plan using this component with projects generated by Angular CLI, please refer to the following article: Using ADF with Angular CLI

See also

• Walkthrough: adding indicators to clearly highlight information about a node

Install

npm install ng2-alfresco-documentlist

Document List

<alfresco-document-list
    #documentList
    [currentFolderId]="'-my-'"
    [contextMenuActions]="true"
    [contentActions]="true"
    [creationMenuActions]="true">
</alfresco-document-list>

Properties

The properties currentFolderId, folderNode and node are the entry initialization properties of the document list. They can not be used together, choose the one that suites more your use case.

Name	Type	Default	Description
selectionMode	string	'single'	Row selection mode. Can be none, single or multiple. For multiple mode you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.
rowStyle	string		The inline style to apply to every row, see NgStyle docs for more details and usage examples
rowStyleClass	string		The CSS class to apply to every row
currentFolderId	string	null	Initial node ID of displayed folder. Can be -root-, -shared-, -my-, or a fixed node ID
folderNode	MinimalNodeEntryEntity	null	Currently displayed folder node
node	NodePaging	null	Document list will show all the node contained in the NodePaging entity
navigate	boolean	true	Toggles navigation to folder content or file preview
navigationMode	string (click,dblclick)	dblclick	User interaction for folder navigation or file preview
thumbnails	boolean	false	Show document thumbnails rather than icons
fallbackThumbnail	string		Path to fallback image to use if the row thumbnail is missing
multiselect	boolean	false	Toggles multiselect mode
contentActions	boolean	false	Toggles content actions for each row
contentActionsPosition	string (left|right)	right	Position of the content actions dropdown menu.
contextMenuActions	boolean	false	Toggles context menus for each row
enablePagination	boolean	true	Shows pagination
creationMenuActions	boolean	true	Toggles the creation menu actions
rowFilter	RowFilter		Custom row filter, see more.
imageResolver	ImageResolver		Custom image resolver, see more.
allowDropFiles	boolean	false	Toggle file drop support for rows (see ng2-alfresco-core/UploadDirective for more details)
sorting	string[]		Defines default sorting. The format is an array of 2 strings [key, direction] i.e. ['name', 'desc'] or ['name', 'asc']. Set this value only if you want to override default sorting detected by the component based on columns.

Events

Name	Description
nodeClick	Emitted when user clicks the node
nodeDblClick	Emitted when user double-clicks the node
folderChange	Emitted upon display folder changed
preview	Emitted when document preview is requested either with single or double click

For a complete example source code please refer to DocumentList Demo repository.

DOM Events

Below are the DOM events the DocumentList component emits. All of them are bubbling, meaning you can handle them in any component up the parent hierarchy, even if DocumentList is wrapped by another component(s).

Name	Description
node-click	Raised when user clicks the node
node-dblclick	Raised when user double-clicks the node

Every event is represented by a CustomEvent instance, having at least the following properties as part of the Event.detail property value:

{
    sender: DocumentListComponent,
    node: MinimalNodeEntity
}

Handling DOM events

Here's a basic example on handling DOM events in the parent elements:

<div (node-click)="onNodeClicked($event)" 
     (node-dblclick)="onNodeDblClicked($event)">
    <div>
        <alfresco-upload-drag-area ...>
             <alfresco-document-list ...>
                ...
             </alfresco-document-list>
        </alfresco-upload-drag-area>
    </div>
</div>

Setting default folder

You can set current folder path by assigning a value for currentFolderId property. It can be either one of the well-known locations as -root-, -shared- or -my- or a node ID (guid).

There may be scenarios when it is needed to set default path based on relative string value rather than node ID. For example when folder name or path is static but it's underlying ID is not (i.e. created manually by admin). In this case you can use alfresco-js-api to get node details based on it's relative path.

Let's try setting default folder to /Sites/swsdp/documentLibrary without knowing it's ID beforehand. For the sake of simplicity example below shows only main points you may need paying attention to:

import { ChangeDetectorRef } from '@angular/core';
import { AlfrescoApiService } from 'ng2-alfresco-core';

export class FilesComponent implements OnInit {

    currentFolderId: string = '-my-';

    constructor(private apiService: AlfrescoApiService,
                private changeDetector: ChangeDetectorRef) {
        // ...
    }

    ngOnInit() {
        let nodes: any = this.apiService.getInstance().nodes;
        nodes.getNodeInfo('-root-', {
            includeSource: true,
            include: ['path', 'properties'],
            relativePath: '/Sites/swsdp/documentLibrary'
        })
        .then(node => {
            console.log(node);
            this.currentFolderId = node.id;
            this.changeDetector.detectChanges();
        });
    }
}

We've added console.log(node) for the getNodeInfo callback just for study and debug purposes. It helps examining other valuable information you can have access to if needed:

Important note: for this particular scenario you must also trigger changeDetector.detectChanges() as in the example above.

Calling DocumentList api directly

Typically you will be binding DocumentList properties to your application/component class properties:

<alfresco-document-list 
    [currentFolderId]="myStartFolder">
</alfresco-document-list>

with the underlying class being implemented similar to the following one:

@Component(...)
export class MyAppComponent {

    myStartFolder: string = '-my-';
    
}

However there may scenarios that require you direct access to DocumentList apis. You can get reference to the DocumentList instance by means of Angular Component Interaction API. See more details in Parent calls a ViewChild section of the official docs.

Here's an example of getting reference:

<alfresco-document-list 
    #documentList
    [currentFolderId]="myStartFolder">
</alfresco-document-list>

Note the #documentList ID we've just added to be able referencing this component later on.

import { ViewChild, AfterViewInit } from '@angular/core';
import { DocumentListComponent } from 'ng2-alfresco-documentlist';

@Component(...)
export class MyAppComponent implements AfterViewInit {

    myStartFolder: string = '-my-';
    
    @ViewChild(DocumentListComponent)
    documentList: DocumentListComponent;

    ngAfterViewInit() {
        console.log(this.documentList);
    }
}

Example above should produce the following browser console output:

Now you are able accessing DocumentList properties or calling methods directly.

// print currently displayed folder node object to console
console.log(documentList.folderNode);

Important note:
It is important accessing child components at least at the AfterViewInit state. Any UI click (buttons, links, etc.) event handlers are absolutely fine. This cannot be ngOnInit event though. You can get more details in Component lifecycle hooks article.

Breadcrumb Component

DocumentList provides simple breadcrumb element to indicate the current position within a navigation hierarchy.

<adf-breadcrumb
    [target]="documentList"
    [folderNode]="documentList.folderNode">
</adf-breadcrumb>

Note: the <alfresco-document-list-breadcrumb> and <adf-breadcrumb> are the same component you can still use the old tag name

Properties

Name	Type	Description
target	DocumentListComponent	(optional) DocumentList component to operate with. Upon clicks will instruct the given component to update.
folderNode	MinimalNodeEntryEntity	Active node, builds UI based on folderNode.path.elements collection.
root	String	(optional) Name of the folder where you want start the breadcrumb. Note the root will always be showed as first element and it will continue to be displayed until you are not in a subfolder of it.

Events

Name	Returned Type	Description
navigate	PathElementEntity	emitted when user clicks on a breadcrumb

Menu Actions

DocumentList provides simple creation menu actions that provide the action to create a new folder.

<alfresco-document-menu-action 
    [folderId]="folderId">
</alfresco-document-menu-action>

When the "New Folder" button is pressed the dialog appears.

Custom columns

It is possible to reorder, extend or completely redefine data columns displayed by the component. By default special $thumbnail and displayName columns are rendered.

A custom set of columns can look like the following:

<alfresco-document-list ...>
    <content-columns>
        <content-column key="$thumbnail" type="image"></content-column>
        <content-column 
            title="Name" 
            key="name" 
            sortable="true"
            class="full-width ellipsis-cell">
        </content-column>
        <content-column 
            title="Created By" 
            key="createdByUser.displayName"
            sortable="true"
            class="desktop-only">
        </content-column>
        <content-column 
            title="Created On" 
            key="createdAt" 
            type="date" 
            format="medium"
            sortable="true"
            class="desktop-only">
        </content-column>
    </content-columns>
</alfresco-document-list>

You can also use HTML-based schema declaration used by DataTable, TaskList and other components:

<alfresco-datatable [data]="data" ...>
    <data-columns>
        <data-column type="image" key="icon" [sortable]="false"></data-column>
        <data-column key="id" title="Id"></data-column>
        <data-column key="createdOn" title="Created"></data-column>
        <data-column key="name" title="Name" class="full-width name-column"></data-column>
        <data-column key="createdBy.name" title="Created By"></data-column>
    </data-columns>
</alfresco-datatable>

DataColumn Properties

Here's the list of available properties you can define for a Data Column definition.

Name	Type	Default	Description
key	string		Data source key, can be either column/property key like title or property path like createdBy.name
type	string (text|image|date)	text	Value type
format	string		Value format (if supported by components), for example format of the date
sortable	boolean	true	Toggles ability to sort by this column, for example by clicking the column header
title	string		Display title of the column, typically used for column headers
template	TemplateRef		Custom column template
sr-title	string		Screen reader title, used for accessibility purposes
class	string		Additional CSS class to be applied to column (header and cells)

DocumentList component assigns an instance of MinimalNode type (alfresco-js-api) as a data context of each row.

export interface MinimalNode {
    id: string;
    parentId: string;
    name: string;
    nodeType: string;
    isFolder: boolean;
    isFile: boolean;
    modifiedAt: Date;
    modifiedByUser: UserInfo;
    createdAt: Date;
    createdByUser: UserInfo;
    content: ContentInfo;
    path: PathInfoEntity;
    properties: NodeProperties;
}

See more details in alfresco-js-api repository.

Binding to nested properties is also supported. You can define a column key as a property path similar to the following:

createdByUser.displayName

Here's a short example:

<alfresco-document-list ...>
    <content-columns>
        <content-column key="$thumbnail" type="image"></content-column>
        <content-column title="Name" key="name" class="full-width ellipsis-cell"></content-column>
        <content-column 
            title="Created By" 
            key="createdByUser.displayName">
        </content-column>
    </content-columns>
</alfresco-document-list>

Column definition

Properties:

Name	Type	Default	Description
title	string		Column title
sr-title	string		Screen reader title, used only when title is empty
key	string		Column source key, example: createdByUser.displayName
sortable	boolean	false	Toggle sorting ability via column header clicks
class	string		CSS class list, example: full-width ellipsis-cell
type	string	text	Column type, text|date|number
format	string		Value format pattern
template	TemplateRef<any>		Column template

For date column type the DatePipe formatting is used. For a full list of available format values please refer to DatePipe documentation.

Column Template

It is possible providing custom column/cell template that may contain other Angular components or HTML elmements:

Every cell in the DataTable component is bound to the dynamic data context containing the following properties:

Name	Type	Description
data	DataTableAdapter	Data adapter instance.
row	DataRow	Current data row instance.
col	DataColumn	Current data column instance.

You can use all three properties to gain full access to underlying data from within your custom templates. In order to wire HTML templates with the data context you will need defining a variable that is bound to $implicit like shown below:

<template let-context="$implicit">
    <!-- template body -->
</template>

The format of naming is let-VARIABLE_NAME="$implicit" where VARIABLE_NAME is the name of the variable you want binding template data context to.

Getting a cell value from the underlying DataTableAdapter:

context.data.getValue(entry.row, entry.col);

You can retrieve all property values for underlying node, including nested properties (via property paths):

context.row.getValue('name')
context.row.getValue('createdByUser.displayName')

You may want using row api to get raw value access.

<content-column title="Name" key="name" sortable="true" class="full-width ellipsis-cell">
    <template let-context="$implicit">
        <span>Hi! {{context.row.getValue('createdByUser.displayName')}}</span>
        <span>Hi! {{context.row.getValue('name')}}</span>
    </template>
</content-column>

Use data api to get values with post-processing, like datetime/icon conversion._

In the Example below will prepend Hi! to each file and folder name in the list:

<content-column title="Name" key="name" sortable="true" class="full-width ellipsis-cell">
    <template let-entry="$implicit">
        <span>Hi! {{entry.data.getValue(entry.row, entry.col)}}</span>
    </template>
</content-column>

In the Example below will add the ng2-alfresco-tag component is integrate in the document list.

<content-column
    title="{{'DOCUMENT_LIST.COLUMNS.TAG' | translate}}"
    key="id"
    sortable="true"
    class="full-width ellipsis-cell">
    <template let-entry="$implicit">
        <alfresco-tag-node-list  [nodeId]="entry.data.getValue(entry.row, entry.col)"></alfresco-tag-node-list>
    </template>
</content-column>

Actions

DocumentList supports declarative actions for Documents and Folders. Each action can be bound to either default out-of-box handler or a custom behavior. You can define both folder and document actions at the same time.

Menu actions

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="document"
            title="System action"
            handler="system2">
        </content-action>

        <content-action
            target="document"
            title="Custom action"
            (execute)="myCustomAction1($event)">
        </content-action>

    </content-actions>
</alfresco-document-list>

export class MyView {
    // ...

    myCustomAction1(event) {
        let entry = event.value.entry;
        alert(`Custom document action for ${entry.name}`);
    }
}

All document actions are rendered as a dropdown menu as on the picture below:

Default action handlers

The following action handlers are provided out-of-box:

• Download (document)
• Delete (document, folder)

All system handler names are case-insensitive, handler="download" and handler="DOWNLOAD" will trigger the same download action.

Delete - Show notification message with no permission

You can show a notification error when the user don't have the right permission to perform the action. The ContentActionComponent provides the event permissionEvent that is raised when the permission specified in the permission property is missing You can subscribe to this event from your component and use the NotificationService to show a message.

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="document"
            title="Delete"
            permission="delete"
            (permissionEvent)="onPermissionsFailed($event)"
            handler="delete">
        </content-action>

    </content-actions>
</alfresco-document-list>

export class MyComponent {

    onPermissionsFailed(event: any) {
        this.notificationService.openSnackMessage(`you don't have the ${event.permission} permission to ${event.action} the ${event.type} `, 4000);
    }

}

Delete - Disable button checking the permission

You can easily disable a button when the user doesn't own the permission to perform the action related to the button. The ContentActionComponent provides the property permission that must contain the permission to check and a property disableWithNoPermission that can be true if you want see the button disabled.

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="document"
            title="Delete"
            permission="delete"
            disableWithNoPermission="true"
            handler="delete">
        </content-action>

    </content-actions>
</alfresco-document-list>

Download

Initiates download of the corresponding document file.

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="document"
            title="Download"
            handler="download">
        </content-action>

    </content-actions>
</alfresco-document-list>

Folder actions

Folder actions have the same declaration as document actions except taget="folder" attribute value.

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="folder"
            title="Default folder action 1"
            handler="system1">
        </content-action>

        <content-action
            target="folder"
            title="Custom folder action"
            (execute)="myFolderAction1($event)">
        </content-action>

    </content-actions>
</alfresco-document-list>

export class MyView {
    // ...

    myFolderAction1(event) {
        let entry = event.value.entry;
        alert(`Custom folder action for ${entry.name}`);
    }
}

Context Menu

DocumentList also provide integration for 'Context Menu Service' from the ng2-alfresco-core library.

You can automatically turn all menu actions (for the files and folders) into context menu items like shown below:

Enabling context menu is very simple:

@Component({
    selector: 'my-view',
    template: `
        <alfresco-document-list>...</alfresco-document-list>
        <context-menu-holder></context-menu-holder>
    `
})
export class MyView {
}

This enables context menu items for documents and folders.

Navigation mode

By default DocumentList component uses 'double-click' mode for navigation. That means user will see the contents of the folder by double-clicking its name or icon (similar to Google Drive behaviour). However it is possible switching to other modes, like single-click navigation for example.

The following navigation modes are supported:

• click
• dblclick

The following example switches navigation to single clicks:

<alfresco-document-list 
    [navigationMode]="'click'">
</alfresco-document-list>

Events

DocumentList emits the following events:

Name	Description
nodeClick	emitted when user clicks a list node
nodeDblClick	emitted when user double-clicks list node
folderChange	emitted once current display folder has changed
preview	emitted when user acts upon files with either single or double click (depends on navigation-mode), recommended for Viewer components integration
permissionError	emitted when user is attempting to create a folder via action menu but it doesn't have the permission to do it
ready	emitted when the documentList is ready and load all the elements

Advanced usage and customization

Custom row filter

You can create a custom row filter implementation that returns true if row should be displayed or false to hide it. Typical row filter implementation is a function that receives ShareDataRow as parameter:

myFilter(row: ShareDataRow): boolean {
    return true;
}

Note that for the sake of simplicity the example code below was reduced to the main points of interest only.

View1.component.html

<alfresco-document-list 
    [rowFilter]="folderFilter">
</alfresco-document-list>

View1.component.ts

import { RowFilter, ShareDataRow } from 'ng2-alfresco-documentlist';

export class View1 {

    folderFilter: RowFilter;

    constructor() {
    
        // This filter will make document list show only folders
        
        this.folderFilter = (row: ShareDataRow) => {
            let node = row.node.entry;
            
            if (node && node.isFolder) {
                return true;
            }
            
            return false;
        };
    }
}

Custom image resolver

You can create a custom image resolver implementation and take full control over how folder/file icons and thumbnails are resolved and what document list should display.

Image resolvers are executed only for columns of the image type.

Typical image resolver implementation is a function that receives DataRow and DataColumn as parameters:

myImageResolver(row: DataRow, col: DataColumn): string {
    return '/path/to/image';
}

Your function can return null or false values to fallback to default image resolving behavior.

Note that for the sake of simplicity the example code below was reduced to the main points of interest only.

View1.component.html

<alfresco-document-list 
    [imageResolver]="folderImageResolver">
    
    <content-columns>
        <content-column key="name" type="image"></content-column>
    </content-columns>
    
    
</alfresco-document-list>

View1.component.ts

import { DataColumn, DataRow } from 'ng2-alfresco-datatable';
import { ImageResolver } from 'ng2-alfresco-documentlist';

export class View1 {

    folderImageResolver: ImageResolver;
    
    constructor() {
        
        // Customize folder icons, leave file icons untouched
        
        this.folderImageResolver = (row: DataRow, col: DataColumn) => {
            let isFolder = <boolean> row.getValue('isFolder');
            if (isFolder) {
                
                // (optional) You may want dynamically getting the column value
                let name = row.getValue(col.key);
                
                // Format image url
                return `http://<my custom path to folder icon>/${name}`;
            }
            
            // For the rest of the cases just fallback to default behaviour.
            return null;
        };
        
    }

}

Hiding columns on small screens

You can hide columns on small screens by means of custom CSS rules:

@media all and (max-width: 768px) {

    alfresco-document-list >>> th.desktop-only .cell-value {
        display: none;
    }

    alfresco-document-list >>> td.desktop-only .cell-value {
        display: none;
    }
}

Now you can declare columns and assign desktop-only class where needed:

<alfresco-document-list ...>
    <content-columns>
        
        <!-- always visible columns -->
        
        <content-column key="$thumbnail" type="image"></content-column>
        <content-column 
                title="Name" 
                key="name" 
                class="full-width ellipsis-cell">
        </content-column>
        
        <!-- desktop-only columns -->
        
        <content-column
                title="Created by"
                key="createdByUser.displayName"
                class="desktop-only">
        </content-column>
        <content-column
                title="Created on"
                key="createdAt"
                type="date"
                format="medium"
                class="desktop-only">
        </content-column>
    </content-columns>
</alfresco-document-list>

Desktop View

Mobile View

Custom 'empty folder' template

By default DocumentList provides the following content for the empty folder:

This can be changed by means of the custom html template:

<alfresco-document-list ...>
    <empty-folder-content>
        <template>
            <h1>Sorry, no content here</h1>
        </template>
    </empty-folder-content>
</alfresco-document-list>

That will give the following output:

Customizing default actions

It is possible extending or replacing the list of available system actions for documents and folders. Actions for the documents and folders can be accessed via the following services:

• DocumentActionsService, document action menu and quick document actions
• FolderActionsService, folder action menu and quick folder actions

Example below demonstrates how a new action handler can be registered with the DocumentActionsService.

<alfresco-document-list ...>
    <content-actions>

        <content-action
            target="document"
            title="My action"
            handler="my-handler">
        </content-action>

    </content-actions>
</alfresco-document-list>

You register custom handler called my-handler that will be executing myDocumentActionHandler function each time upon being invoked.

import { DocumentActionsService } from 'ng2-alfresco-documentlist';

export class MyView {

    constructor(documentActions: DocumentActionsService) {
        documentActions.setHandler(
            'my-handler',
            this.myDocumentActionHandler.bind(this)
        );
    }

    myDocumentActionHandler(obj: any) {
        window.alert('my custom action handler');
    }
}

The same approach allows changing the way out-of-box action handlers behave. Registering custom action with the name download replaces default one:

export class MyView {

    constructor(documentActions: DocumentActionsService) {
        documentActions.setHandler(
            'download',
            this.customDownloadBehavior.bind(this)
        );
    }

    customDownloadBehavior(obj: any) {
        window.alert('my custom download behavior');
    }
}

Typically you may want populating all your custom actions at the application root level or by means of custom application service.

Build from sources

You can build component from sources with the following commands:

npm install
npm run build

The build task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.

NPM scripts

Command	Description
npm run build	Build component
npm run test	Run unit tests in the console
npm run test-browser	Run unit tests in the browser
npm run coverage	Run unit tests and display code coverage report

Demo

Please check the demo folder for a demo project

cd demo
npm install
npm start

License

Apache Version 2.0