[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:
Andy Stark
2018-01-12 13:25:54 +00:00
committed by Eugenio Romano
parent f6cf036769
commit 72cfd7894d
4 changed files with 116 additions and 1 deletions

View File

@@ -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;

View File

@@ -55,45 +55,61 @@ export class LoginComponent implements OnInit {
isPasswordShow: boolean = false;
/* Should the `Remember me` checkbox be shown? */
@Input()
showRememberMe: boolean = true;
/* Should the extra actions (`Need Help`, `Register`, etc) be shown? */
@Input()
showLoginActions: boolean = true;
/* Sets the URL of the NEED HELP link in the footer */
@Input()
needHelpLink: string = '';
/* Sets the URL of the REGISTER link in the footer */
@Input()
registerLink: string = '';
/* Path to a custom logo image */
@Input()
logoImageUrl: string = './assets/images/alfresco-logo.svg';
/* Path to a custom background image */
@Input()
backgroundImageUrl: string = './assets/images/background.svg';
/* The copyright text below the login box */
@Input()
copyrightText: string = '\u00A9 2016 Alfresco Software, Inc. All Rights Reserved.';
/* Possible valid values are ECM, BPM or ALL. By default, this component
* will log in only to ECM. If you want to log in in both systems then use ALL.
*/
@Input()
providers: string;
/* Custom validation rules for the login form */
@Input()
fieldsValidation: any;
/* Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
@Input()
disableCsrf: boolean;
/* Route to redirect to on successful login. */
@Input()
successRoute: string = null;
/* Emitted when the login is successful */
@Output()
success = new EventEmitter<LoginSuccessEvent>();
/* Emitted when the login fails */
@Output()
error = new EventEmitter<LoginErrorEvent>();
/* Emitted when the login form is submitted */
@Output()
executeSubmit = new EventEmitter<LoginSubmitEvent>();