From dd25467a98fad2898a2b71d07fa50bb175cea81c Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Thu, 3 Jan 2019 15:38:51 +0000 Subject: [PATCH] update documentation (#4109) --- .../document-list.component.md | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index 9a7daea012..8e8e97cab0 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -27,6 +27,7 @@ Displays the documents from a repository. - [Calling DocumentList api directly](#calling-documentlist-api-directly) - [Underlying node object](#underlying-node-object) - [Custom columns](#custom-columns) + - [Column templates](#column-templates) - [Date Column](#date-column) - [Location Column](#location-column) - [Actions](#actions) @@ -561,25 +562,30 @@ You can also add tooltips, styling, automatic column title translation and other You can use the following components as column templates: -* adf-name-column -* adf-library-name-column -* adf-library-role-column -* adf-library-status-column +| Name | Description | +| --- | --- | +| adf-name-column | Renders 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-column | Renders 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-column | Renders i18n-enabled information about Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) | +| adf-library-status-column | Renders i18n-enabled information about Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`)| +| adf-trashcan-name-column | Renders a name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. | + +All components above require only `context` property to be bound, +each component fetches and renders the information it needs from the underlying node. -All components above require `context` property to be bound. For example: ```html - + ``` +> All the components above also participate in the Extensibility +> and can be used to compose DocumentList layouts from within the plugins. + ### Date Column For the `date` column type, the Angular [DatePipe](https://angular.io/docs/ts/latest/api/common/DatePipe-class.html) formatting is used.