Welcome to the Alfresco Builder Network

Displays the documents from a repository.

Custom columns

Contents

Basic Usage

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

Class members

Properties

NameTypeDefault valueDescription
allowDropFilesbooleanfalseToggle file drop support for rows (see Upload Directive for further details)
contentActionsbooleanfalseToggles content actions for each row
contentActionsPositionstring"right"Position of the content actions dropdown menu. Can be set to "left" or "right".
contextMenuActionsbooleanfalseToggles context menus for each row
currentFolderIdstringnullThe ID of the folder node to display or a reserved string alias for special sources
displaystringDisplayMode.ListChange the display mode of the table. Can be "list" or "gallery".
emptyFolderImageUrlstringCustom image for empty folder. Default value: './assets/images/empty_doc_lib.svg'
imageResolverany | nullnullCustom image resolver
includeFieldsstring[]Include additional information about the node in the server request. For example: association, isLink, isLocked and others.
loadingbooleanfalseToggles the loading state and animated spinners for the component. Used in combination with navigate=false to perform custom navigation and loading state indication.
locationFormatstring"/"The default route for all the location-based columns (if declared).
maxItemsnumberDefault value is stored into user preference settings use it only if you are not using the pagination
multiselectbooleanfalseToggles multiselect mode
navigatebooleantrueToggles navigation to folder content or file preview
navigationModestringUser interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick"
nodeNodePagingnullThe Document list will show all the nodes contained in the NodePaging entity
permissionsStylePermissionStyleModel[][]Define a set of CSS styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples.
rowFilterany | nullnullCustom row filter
rowStylestringThe inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples.
rowStyleClassstringThe CSS class to apply to every row
selectionModestring"single"Row selection mode. Can be null, single or multiple. For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.
showHeaderbooleantrueToggles the header
sortingstring[]['name', 'asc']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 the default sorting detected by the component based on columns.
sortingModestring"client"Defines sorting mode. Can be either client (items in the list are sorted client-side) or server (the ordering supplied by the server is used without further client-side sorting). Note that the server option does not request the server to sort the data before delivering it.
thumbnailsbooleanfalseShow document thumbnails rather than icons

Events

NameTypeDescription
errorEventEmitter<any>Emitted when the API fails to get the Document List data
folderChangeEventEmitter<NodeEntryEvent>Emitted when the current display folder changes
nodeClickEventEmitter<NodeEntityEvent>Emitted when the user clicks a list node
nodeDblClickEventEmitter<NodeEntityEvent>Emitted when the user double-clicks a list node
previewEventEmitter<NodeEntityEvent>Emitted when the user acts upon files with either single or double click (depends on navigation-mode). Useful for integration with the Viewer component.
readyEventEmitter<NodePaging>Emitted when the Document List has loaded all items and is ready for use

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 :

Document List Folders

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.

NameDescription
node-clickEmitted when user clicks the node
node-dblclickEmitted when user double-clicks the node
node-selectEmitted when user selects a node
node-unselectEmitted when user unselects a node

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:

card-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:

documentLibrary

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:

view-child

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 MinimalNode (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:

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

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>

Custom columns

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:

NameDescription
adf-name-columnRenders hyperlink-styled name of the node. Provides formatted tooltip. Emits name-click DOM event that can be handled by any parent component.
adf-library-name-columnRenders library name. Provides formatted tooltips and extra details for libraries with same names on the page. Emits name-click DOM event that can be handled by any parent component.
adf-library-role-columnRenders i18n-enabled information about Library (Site) role (Manager, Collaborator, Contributor, Consumer)
adf-library-status-columnRenders i18n-enabled information about Library (Site) status (Public, Private, Moderated, Unknown)
adf-trashcan-name-columnRenders a name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips.

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 [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.

You can also use the Context Menu directive from the ADF Core library to show the actions you have defined in a context menu:

@Component({
    selector: 'my-view',
    template: `
        <adf-document-list [contextMenuActions]="true">...</adf-document-list>
        <adf-context-menu-holder></context-menu-holder>
    `
})
class MyView {
}

Folder context menu

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>

Advanced usage and customization

Custom row filter

You can create a custom row filter function that returns true if the row should be displayed or false if it should be hidden. A typical row filter implementation receives a ShareDataRow object as a 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

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

View1.component.ts

import { RowFilter, ShareDataRow } from '@alfresco/adf-content-services';

class View1 {

    folderFilter: RowFilter;

    constructor() {
    
        // This filter will make the 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 function to manage the way folder/file icons and thumbnails are resolved (ie, which image is shown for which item).

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

A typical image resolver implementation receives DataRow and DataColumn objects as parameters:

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

Your function can return null or false values to fall back to the 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

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

View1.component.ts

import { DataColumn, DataRow } from '@alfresco/adf-core';
import { ImageResolver } from '@alfresco/adf-content-services';

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

}

Custom 'empty folder' template

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

Default empty folder

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

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

This will give the following output:

Custom empty folder

Custom 'permission denied' template

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

Default no permission

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

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

This will give the following output:

Custom no permission

See also

Interested in trying Alfresco?

Try Now