Document List component

Displays the documents from a repository.

Contents

• Basic Usage
• Class members
  • Properties
  • Events
• Details
  • DOM Events
  • Conditional visibility
  • Card view
  • Pagination strategy
  • Data Sources
  • Setting default folder
  • Calling DocumentList api directly
  • Underlying node object
  • Custom columns
  • Column templates
  • Date Column
  • Location Column
  • Actions
  • Navigation mode
  • Header filters
• Advanced usage and customization
  • Image Resolver and Row Filter functions
  • Custom 'empty folder' template
  • Custom 'permission denied' template
  • Custom 'loading' template
  • File Auto downloading
• See also

Basic Usage

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

Class members

Properties

Events

Details

The properties currentFolderId and node set the initial folder shown by the Document List. They cannot be used together, so choose the one that suits your use case best.

The Document list will automatically show special icons for : Smart Folder, Link to a Folder and Folder with rules as shown below :

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 the DocumentList is wrapped by one or more other components.

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

{
    sender: DocumentListComponent,
    node: NodeEntry
}

See the DataTable documentation for further details about the other DOM events that the Document List component bubbles up from the DataTable.

Below is a basic example of handling DOM events in the parent elements.

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

Conditional visibility

You can use ngIf directives to provide conditional visibility support for the columns:

<data-column
    *nfIg="showNameColumn"
    key="name"
    title="MY.RESOURCE.KEY">
</data-column>

Card view

The Document List has an option to display items as "cards" instead of the standard view:

Set the [display] property to "gallery" to enable card view mode:

<adf-document-list
    [currentFolderId]="'-my-'"
    [display]="'gallery'">
</adf-document-list>

Pagination strategy

The Document List by default supports 2 types of pagination: Pagination component and Infinite pagination component

Pagination component

<adf-document-list #documentList ...></adf-document-list>

<adf-pagination
    [target]="documentList"">
</adf-pagination>

Infinite pagination component

<adf-document-list #documentList ...></adf-document-list>

<adf-infinite-pagination 
    [target]="documentList"
    [loading]="documentList.infiniteLoading">
</adf-infinite-pagination>

Data Sources

You can use any of the following options to set the folder that the Document List will display:

Node ID

The unique identifier of the Node. Gets automatically updated when you perform navigation to other folders.

Repository aliases

You can use one of the well-known reserved aliases:

• -root-
• -shared-
• -my-

Document List aliases

The Document List component also provides support for the following reserved aliases:

• -trashcan-,
• -sharedlinks-
• -sites-
• -mysites-
• -favorites-
• -recent-

Note that due to the nature of the data, these sources do not support navigation. You may want to handle single and double clicks yourself to perform navigation to other sources.

The Document List component supports default presets for all the custom sources mentioned earlier. If you don't provide any custom column definition with the Data Column component then a default preset will be automatically used at runtime.

Some of the presets use the Location columns that allow you to navigate to the parent folder of the node (eg, navigating from the "Favorite" node to the folder that contains it). You can set the default location format using the locationFormat property to avoid redefining the entire column layout.

The default column layout for non-reserved views is:

• Icon
• Name
• Size
• Modified (date)
• Modified by

Trashcan

<adf-document-list
    currentFolderId="-trashcan-"
    locationFormat="/files">
</adf-document-list>

Default layout:

• Icon
• Name
• Location
• Size
• Deleted
• Deleted by

Shared Links

<adf-document-list
    currentFolderId="-sharedlinks-"
    locationFormat="/files">
</adf-document-list>

Default layout:

• Icon
• Name
• Location
• Size
• Modified
• Modified by
• Shared by

Sites

<adf-document-list
    currentFolderId="-sites-">
</adf-document-list>

Default layout:

• Icon
• Title
• Status

My Sites

<adf-document-list
    currentFolderId="-mysites-">
</adf-document-list>

Default layout:

• Icon
• Title
• Status

Favorites

<adf-document-list
    currentFolderId="-favorites-"
    locationFormat="/files">
</adf-document-list>

Default layout:

• Icon
• Name
• Location
• Size
• Modified
• Modified by

Recent Files

<adf-document-list
    currentFolderId="-recent-"
    locationFormat="/files">
</adf-document-list>

Default layout:

• Icon
• Name
• Location

Setting default folder

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

There may be scenarios where you need to set the default path based on a relative string value rather than a node ID. This might happen, for example, when the folder name or path is static but its underlying ID is not (i.e. created manually by admin). In this case you can use the alfresco-js-api to get the details of a node based on its relative path.

The example below shows how to set the default folder to /Sites/swsdp/documentLibrary without knowing its ID beforehand. For the sake of simplicity, the example below shows only the main points you should pay attention to:

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

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();
        });
    }
}

<adf-document-list
    [currentFolderId]="currentFolderId">
</adf-document-list>

The console.log(node) for the getNodeInfo callback is just for study and debug purposes. It is useful for examining other information that you can access if necessary:

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

Calling DocumentList api directly

Typically you will bind Document List properties to your application/component class properties:

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

...with the underlying class implemented as in the following example:

@Component(...)
class MyAppComponent {

    myStartFolder: string = '-my-';
    
}

However there may be scenarios where you need direct access to the Document List APIs. You can get a reference to the Document List instance using the Angular Component Interaction API. See the Parent calls a ViewChild section of the Angular docs for more information.

Below is an example of getting a reference:

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

Note that the #documentList ID allows the component to be referenced elsewhere.

import { ViewChild, AfterViewInit } from '@angular/core';
import { DocumentListComponent } from '@alfresco/adf-content-services';

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

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

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

The example above should produce the following browser console output:

Now you can access Document List properties or call methods directly:

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

Important note: You must not access child components any earlier in the component lifecycle than the AfterViewInit state. Any UI click (buttons, links, etc.) event handlers are fine but an earlier event like ngOnInit is not. See the Angular Component lifecycle hooks documentation for a full explanation of the component lifecycle.

Underlying node object

The Document List component assigns an instance of the Node class (defined in the Alfresco JS API) as the data context for each row. You can make use of the properties of this object when defining custom columns:

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:

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

Custom columns

You can 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 might look like the following:

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

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

<adf-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>
</adf-datatable>

You can also add tooltips, styling, automatic column title translation and other features. See the DataColumn component page for more information about specifying and customizing columns.

Column templates

You can use the following components as column templates:

All the components above require only the context property to be bound, since each component fetches and renders the information it needs from the underlying node.

For example:

<data-column key="name" title="Name">
    <ng-template let-context>
        <adf-name-column key="name" [context]="context"></adf-name-column>
    </ng-template>
</data-column>

All the components above also participate in Extensibility and can be used to compose DocumentList layouts from within the plugins.

Date Column

For the date column type, the Angular DatePipe formatting is used. See the DatePipe documentation for a full list of format values it supports.

ADF also supports an additional timeAgo value for the format property. This renders date values using the popular "Time from now" format.

Location Column

This column displays a clickable location link pointing to the parent path of the node.

Important note:

For granular permissions, the Location Column may or may not render the link location

You would normally use this with custom navigation or when displaying content from sources like:

• Sites
• My Sites
• Shared Links
• Recent Files
• Favorites
• Trashcan

...or any other location where the user needs to be able to navigate to the node parent folder easily.

Note that the parent node is evaluated automatically. The generated link will have a URL based on the format property value with the node id value appended:

/<format>/:id

For example:

<data-column
    key="path"
    type="location"
    format="/files"
    title="Location">
</data-column>

All links rendered in the column above will have an address mapped to /files:

/files/node-1-id
/files/node-2-id
...

Actions

You can add actions to a dropdown menu for each item shown in a Document List. Several built-in actions are available (delete, download, copy and move) but you can also define your own actions. See the Content Action component for more information and examples.

@Component({
    selector: 'my-view',
    template: `
        <adf-document-list [contextMenuActions]="true">
            <content-actions>
                <content-action
                    title="Copy"
                    permission="update"
                    [disableWithNoPermission]="true"
                    handler="copy">
                </content-action>
                <content-action
                    title="Delete"
                    permission="delete"
                    disableWithNoPermission="true"
                    handler="delete">
                </content-action>
            </content-actions>
        </adf-document-list>
    `
})
class MyView {
}

This single extra line in the template enables context menu items for documents and folders.

Navigation mode

By default, the Document List component uses 'double-click' mode for navigation. That means that the user will see the contents of the folder when they double-click its name or icon (in a similar manner to Google Drive). However, there is also a single-click mode that may be sometimes be useful.

The following example switches navigation to single clicks:

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

Header filters

You can enable Header filters in your document list simply setting to true its headerFilters input.

<adf-document-list 
    currentFolderId="-my-" 
    [headerFilters]="true">
</adf-document-list>

Advanced usage and customization

Image Resolver and Row Filter functions

The Document List has two properties that let you modify behavior with custom functions:

• imageResolver - Specifies a function to choose image file paths for icons and thumbnails.
• rowFilter - Selects whether a row is shown or hidden according to its data content.

See the Image Resolver Model and Row Filter Model pages for details of how to implement these functions.

Custom 'empty folder' template

By default, the Document List provides the following content for the empty folder:

However, you can change this by defining your own custom HTML template:

<adf-document-list ...>
    <adf-custom-empty-content-template>
        <h1>Sorry, no content here</h1>
    </adf-custom-empty-content-template>
</adf-document-list>

This will give the following output:

Custom 'permission denied' template

By default, the Document List shows the following content when permission is denied:

You can change this by defining your own custom HTML template:

<adf-document-list ...>
    <adf-custom-no-permission-template>
        <h1>You don't have permissions</h1>
    </adf-custom-no-permission-template>
</adf-document-list>

This will give the following output:

Custom 'loading' template

By default, the Document List shows the following content when the content is loading:

You can change this by defining your own custom HTML template:

<adf-document-list ...>
    <adf-custom-loading-content-template>
        Loading Content
        <mat-progress-bar mode="indeterminate"></mat-progress-bar>
    </adf-custom-loading-content-template>
</adf-document-list>

This will give the following output:

File Auto downloading

In case of files exceeding a predefined file size, the document list component can be configured to automatically download those file when trying to preview them. This can help in reducing server load, and ensuring quick access to such files. After turning this feature on, whenever the user tries to preview a file with a large file size, the Document List component will first preview a dialog, asking for confirmation from the user on whether they want to download the file, or cancel the preview altogether.

In order to configure the Document List to automatically download the files, the following environment variables would need to be set up in app.config.json -

"viewer": {
    "enableFileAutoDownload": true,
    "fileAutoDownloadSizeThresholdInMB": 15
}

Here, "enableFileAutoDownload": true, would enable the file auto download feature on the Document List component. Setting this flag to false disables this feature, and always triggers a file preview when trying to view a file, regardless of its size.

The second configuration here, "fileAutoDownloadSizeThresholdInMB": 15 specifies the file size threshold (in MB), after which the Document List component will start downloading the file. In the example provided above, any file greater than 15MB in size would trigger the auto download functionality. Files lower than 15MB in size would continue to preview normally.

See also

• Datatable component
• Data column component
• Pagination component
• Infinite pagination component
• Sites dropdown component
• Metadata indicators
• Nodes api service
• Breadcrumb component
• Content action component
• Content node selector component
• Document list service
• Dropdown breadcrumb component
• Permissions style model
• Version manager component
• Viewer component