mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1769] Added JSDoc for components (#2823)
* [ADF-1769] Added JSDoc for components * [ADF-1769] Fixed tslint error with trailing whitespace
This commit is contained in:
committed by
Eugenio Romano
parent
f6cf036769
commit
72cfd7894d
@@ -49,57 +49,82 @@ export class DataTableComponent implements AfterContentInit, OnChanges, DoCheck
|
||||
@ContentChild(DataColumnListComponent)
|
||||
columnList: DataColumnListComponent;
|
||||
|
||||
/* Data source for the table */
|
||||
@Input()
|
||||
data: DataTableAdapter;
|
||||
|
||||
/* The rows that the datatable will show */
|
||||
@Input()
|
||||
rows: any[] = [];
|
||||
|
||||
/* Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
|
||||
* you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.
|
||||
*/
|
||||
@Input()
|
||||
selectionMode: string = 'single'; // none|single|multiple
|
||||
|
||||
/* Toggles multiple row selection, which renders checkboxes at the beginning of each row */
|
||||
@Input()
|
||||
multiselect: boolean = false;
|
||||
|
||||
/* Toggles data actions column */
|
||||
@Input()
|
||||
actions: boolean = false;
|
||||
|
||||
/* Position of the actions dropdown menu. Can be "left" or "right". */
|
||||
@Input()
|
||||
actionsPosition: string = 'right'; // left|right
|
||||
|
||||
/* Fallback image for row where thumbnail is missing */
|
||||
@Input()
|
||||
fallbackThumbnail: string;
|
||||
|
||||
/* Toggles custom context menu for the component */
|
||||
@Input()
|
||||
contextMenu: boolean = false;
|
||||
|
||||
/* Toggle file drop support for rows (see Upload Directive for further details) */
|
||||
@Input()
|
||||
allowDropFiles: boolean = false;
|
||||
|
||||
/* The inline style to apply to every row. See
|
||||
* [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html)
|
||||
* docs for more details and usage examples.
|
||||
*/
|
||||
@Input()
|
||||
rowStyle: string;
|
||||
|
||||
/* The CSS class to apply to every row */
|
||||
@Input()
|
||||
rowStyleClass: string = '';
|
||||
|
||||
/* Toggles the header */
|
||||
@Input()
|
||||
showHeader: boolean = true;
|
||||
|
||||
/* Emitted when user clicks the row */
|
||||
@Output()
|
||||
rowClick = new EventEmitter<DataRowEvent>();
|
||||
|
||||
/* Emitted when user double-clicks the row */
|
||||
@Output()
|
||||
rowDblClick = new EventEmitter<DataRowEvent>();
|
||||
|
||||
/* Emitted before context menu is displayed for a row */
|
||||
@Output()
|
||||
showRowContextMenu = new EventEmitter<DataCellEvent>();
|
||||
|
||||
/* Emitted before actions menu is displayed for a row */
|
||||
@Output()
|
||||
showRowActionsMenu = new EventEmitter<DataCellEvent>();
|
||||
|
||||
/* Emitted when row action is executed by user */
|
||||
@Output()
|
||||
executeRowAction = new EventEmitter<DataRowActionEvent>();
|
||||
|
||||
/* Flag that indicates if the datatable is in loading state and needs to show the
|
||||
* loading template (see the docs to learn how to configure a loading template).
|
||||
*/
|
||||
@Input()
|
||||
loading: boolean = false;
|
||||
|
||||
|
Reference in New Issue
Block a user