mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1769] Added JSDocs and updated prop table script (#2838)
* [ADF-1769] Added JSDocs and updated prop table script * [ADF-1769] Fixed lint error in JSDoc
This commit is contained in:
committed by
Eugenio Romano
parent
3461749dc6
commit
c9a3b048b4
@@ -25,33 +25,44 @@ import { Component, ContentChild, Input, OnInit, TemplateRef } from '@angular/co
|
||||
})
|
||||
export class DataColumnComponent implements OnInit {
|
||||
|
||||
/** Data source key. Can be either a column/property key like `title`
|
||||
* or a property path like `createdBy.name`.
|
||||
*/
|
||||
@Input()
|
||||
key: string;
|
||||
|
||||
/** Value type for the column. Possible settings are 'text', 'image',
|
||||
* 'date', 'fileSize' and 'location'.
|
||||
*/
|
||||
@Input()
|
||||
type: string = 'text';
|
||||
|
||||
/** Value format (if supported by the parent component), for example format of the date. */
|
||||
@Input()
|
||||
format: string;
|
||||
|
||||
/** Toggles ability to sort by this column, for example by clicking the column header. */
|
||||
@Input()
|
||||
sortable: boolean = true;
|
||||
|
||||
/** Display title of the column, typically used for column headers. You can use the
|
||||
* i18n resource key to get it translated automatically.
|
||||
*/
|
||||
@Input()
|
||||
title: string = '';
|
||||
|
||||
@ContentChild(TemplateRef)
|
||||
template: any;
|
||||
|
||||
/** Custom tooltip formatter function. */
|
||||
@Input()
|
||||
formatTooltip: Function;
|
||||
|
||||
/**
|
||||
* Title to be used for screen readers.
|
||||
*/
|
||||
/** Title to be used for screen readers. */
|
||||
@Input('sr-title')
|
||||
srTitle: string;
|
||||
|
||||
/** Additional CSS class to be applied to column (header and cells). */
|
||||
@Input('class')
|
||||
cssClass: string;
|
||||
|
||||
|
Reference in New Issue
Block a user