mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

Andy Stark 487147ca22 [ADF-2451] Reviewed docs for components (#3055 )

2018-03-09 13:47:44 +00:00

25 KiB

Raw Blame History

Added, Status, Last reviewed

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

Document List component

Displays the documents from a repository.

Basic Usage
- Properties
- Events
Details
Advanced usage and customization
See also

Basic Usage

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

Properties

Name	Type	Default value	Description
display	`string`	`DisplayMode.List`	Change the display mode of the table. Can be "list" or "gallery".
permissionsStyle	`PermissionStyleModel[]`	`[]`	Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples.
locationFormat	`string`	`'/'`	The default route for all the location-based columns (if declared).
navigate	`boolean`	`true`	Toggles navigation to folder content or file preview
showHeader	`boolean`	`true`	Toggles the header
navigationMode	`string`	See description	User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick"
thumbnails	`boolean`	`false`	Show document thumbnails rather than icons
selectionMode	`string`	`'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.
multiselect	`boolean`	`false`	Toggles multiselect mode
contentActions	`boolean`	`false`	Toggles content actions for each row
contentActionsPosition	`string`	`'right'`	Position of the content actions dropdown menu. Can be set to "left" or "right".
contextMenuActions	`boolean`	`false`	Toggles context menus for each row
emptyFolderImageUrl	`string`	See description	Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg'
allowDropFiles	`boolean`	`false`	Toggle file drop support for rows (see Upload Directive for further 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 the default sorting detected by the component based on columns.
rowStyle	`string`		The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples.
rowStyleClass	`string`		The CSS class to apply to every row
loading	`boolean`	`false`	Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication.
rowFilter	`any`	`null`	Custom row filter
imageResolver	`any`	`null`	Custom image resolver
currentFolderId	`string`	`null`	The ID of the folder node to display or a reserved string alias for special sources
folderNode	`MinimalNodeEntryEntity`	`null`	Currently displayed folder node
node	`NodePaging`	`null`	The Document list will show all the nodes contained in the NodePaging entity
maxItems	`number`		Default value is stored into user preference settings
skipCount	`number`	`0`	Number of elements to skip over for pagination purposes
enableInfiniteScrolling	`boolean`	`false`	Set document list to work in infinite scrolling mode

Events

Name	Type	Description
nodeClick	`EventEmitter<NodeEntityEvent>`	Emitted when the user clicks a list node
nodeDblClick	`EventEmitter<NodeEntityEvent>`	Emitted when the user double-clicks a list node
folderChange	`EventEmitter<NodeEntryEvent>`	Emitted when the current display folder changes
preview	`EventEmitter<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.
ready	`EventEmitter<NodePaging>`	Emitted when the Document List has loaded all items and is ready for use
error	`EventEmitter<any>`	Emitted when the API fails to get the Document List data

Details

The properties currentFolderId, folderNode 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.

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.

Name	Description
node-click	Emitted when user clicks the node
node-dblclick	Emitted when user double-clicks the node
node-select	Emitted when user selects a node
node-unselect	Emitted 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: MinimalNodeEntity
}

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>

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: finite and infinite:

With finite pagination, the Document List needs 2 parameters: maxItems and skipCount. These set the maximum number of items shown in a single page and the start offset of the first item in the page (ie, the number of items you need to skip to get there).
You can enable infinite pagination by setting the same parameters plus an extra third parameter: enableInfiniteScrolling.

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

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

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(...)
export 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({...})
export 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.folderNode);

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](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md] (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>

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.

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 the render 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>
        <context-menu-holder></context-menu-holder>
    `
})
export class MyView {
}

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

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

export 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';

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

}

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 ...>
    <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 '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 ...>
    <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:

25 KiB

Raw Blame History

Document List component

Contents

Basic Usage

Properties

Events

Details

DOM Events

Card view

Data Sources

Node ID

Repository aliases

Document List aliases

Setting default folder

Calling DocumentList api directly

Underlying node object

Custom columns

Date Column

Location Column

Actions

Navigation mode

Advanced usage and customization

Custom row filter

Custom image resolver

Custom 'empty folder' template

Custom 'permission denied' template

See also

25 KiB Raw Blame History

Document List component

Contents

Basic Usage

Properties

Events

Details

DOM Events

Card view

Pagination strategy

Data Sources

Node ID

Repository aliases

Document List aliases

Setting default folder

Calling DocumentList api directly

Underlying node object

Custom columns

Date Column

Location Column

Actions

Navigation mode

Advanced usage and customization

Custom row filter

Custom image resolver

Custom 'empty folder' template

Custom 'permission denied' template

See also

25 KiB

Raw Blame History