diff --git a/ng2-components/ng2-alfresco-documentlist/README.md b/ng2-components/ng2-alfresco-documentlist/README.md index 1966fb67d8..a33a142931 100644 --- a/ng2-components/ng2-alfresco-documentlist/README.md +++ b/ng2-components/ng2-alfresco-documentlist/README.md @@ -377,12 +377,35 @@ Every folder action is rendered as a separate button. ![Quick folder Actions](docs/assets/quick-folder-actions.png) +### 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 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: + +```html + + +``` + ### Events Document List emits the following events: -- itemClick -- folderChange +| Name | Description | +| --- | --- | +| itemClick | emitted when user clicks a document list entry | +| itemDblClick | emitted when user double-clicks document a document list entry | +| 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 | ### itemClick event