inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation (#4109)

Browse Source
This commit is contained in:
Denys Vuika 2019-01-03 15:38:51 +00:00 committed by Eugenio Romano
parent 90676a4a3c
commit dd25467a98
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/content-services/document-list.component.md
View File

@ -27,6 +27,7 @@ Displays the documents from a repository.
- [Calling DocumentList api directly](#calling-documentlist-api-directly) - [Calling DocumentList api directly](#calling-documentlist-api-directly)
- [Underlying node object](#underlying-node-object) - [Underlying node object](#underlying-node-object)
- [Custom columns](#custom-columns) - [Custom columns](#custom-columns)
- [Column templates](#column-templates)
- [Date Column](#date-column) - [Date Column](#date-column)
- [Location Column](#location-column) - [Location Column](#location-column)
- [Actions](#actions) - [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: You can use the following components as column templates:
* adf-name-column | Name | Description |
* adf-library-name-column | --- | --- |
* adf-library-role-column | 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-status-column | 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: For example:
```html ```html
<data-column <data-column key="name" title="Name">
key="name"
title="{{'DOCUMENT_LIST.COLUMNS.DISPLAY_NAME' | translate}}"
class="adf-full-width adf-ellipsis-cell">
<ng-template let-context> <ng-template let-context>
<adf-name-column [context]="context"></adf-name-column> <adf-name-column [context]="context"></adf-name-column>
</ng-template> </ng-template>
</data-column> </data-column>
``` ```
> All the components above also participate in the Extensibility
> and can be used to compose DocumentList layouts from within the plugins.
### Date Column ### Date Column
For the `date` column type, the Angular [DatePipe](https://angular.io/docs/ts/latest/api/common/DatePipe-class.html) formatting is used. For the `date` column type, the Angular [DatePipe](https://angular.io/docs/ts/latest/api/common/DatePipe-class.html) formatting is used.