inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added prop tables and fixed script (#2896)

Browse Source 
* [ADF-1769] Added prop tables and fixed script

* [ADF-1769] Corrected JSDoc formatting errors

* [ADF-1769] Restored default column to prop tables
This commit is contained in:
Andy Stark
2018-01-31 09:22:05 +00:00
committed by Eugenio Romano
parent 8a4959d172
commit 900fd70d63
56 changed files with 601 additions and 519 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/core/form/components/form-field/form-field.component.ts
View File

@@ -54,6 +54,11 @@ export class FormFieldComponent implements OnInit, OnDestroy {
@ViewChild('container', { read: ViewContainerRef })
container: ViewContainerRef;
/** Contains all the necessary data needed to determine what UI Widget
* to use when rendering the field in the form. You would typically not
* create this data manually but instead create the form in APS and export
* it to get to all the `FormFieldModel` definitions.
*/
@Input()
field: FormFieldModel = null;

1
lib/core/form/components/form-list.component.ts
View File

@@ -26,6 +26,7 @@ import { FormService } from './../services/form.service';
})
export class FormListComponent implements OnChanges {
/** The array that contains the information to show inside the list. */
@Input()
forms: any [] = [];

28
lib/core/form/components/form.component.ts
View File

@@ -41,81 +41,109 @@ export class FormComponent implements OnInit, OnChanges {
static COMPLETE_BUTTON_COLOR: string = 'primary';
static COMPLETE_OUTCOME_NAME: string ='Complete'
/** Underlying form model instance. */
@Input()
form: FormModel;
/** Task id to fetch corresponding form and values. */
@Input()
taskId: string;
/** Content Services node ID for the form metadata. */
@Input()
nodeId: string;
/** The id of the form definition to load and display with custom values. */
@Input()
formId: string;
/** Name of the form definition to load and display with custom values. */
@Input()
formName: string;
/** Toggle saving of form metadata. */
@Input()
saveMetadata: boolean = false;
/** Custom form values map to be used with the rendered form. */
@Input()
data: FormValues;
/** Path of the folder where the metadata will be stored. */
@Input()
path: string;
/** Name to assign to the new node where the metadata are stored. */
@Input()
nameNode: string;
/** Toggle rendering of the form title. */
@Input()
showTitle: boolean = true;
/** Toggle rendering of the `Complete` outcome button. */
@Input()
showCompleteButton: boolean = true;
/** If true then the `Complete` outcome button is shown but it will be disabled. */
@Input()
disableCompleteButton: boolean = false;
/** If true then the `Start Process` outcome button is shown but it will be disabled. */
@Input()
disableStartProcessButton: boolean = false;
/** Toggle rendering of the `Save` outcome button. */
@Input()
showSaveButton: boolean = true;
/** Toggle debug options. */
@Input()
showDebugButton: boolean = false;
/** Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. */
@Input()
readOnly: boolean = false;
/** Toggle rendering of the `Refresh` button. */
@Input()
showRefreshButton: boolean = true;
/** Toggle rendering of the validation icon next to the form title. */
@Input()
showValidationIcon: boolean = true;
/** Contains a list of form field validator instances. */
@Input()
fieldValidators: FormFieldValidator[] = [];
/** Emitted when the form is submitted with the `Save` or custom outcomes. */
@Output()
formSaved: EventEmitter<FormModel> = new EventEmitter<FormModel>();
/** Emitted when the form is submitted with the `Complete` outcome. */
@Output()
formCompleted: EventEmitter<FormModel> = new EventEmitter<FormModel>();
/** Emitted when form content is clicked. */
@Output()
formContentClicked: EventEmitter<ContentLinkModel> = new EventEmitter<ContentLinkModel>();
/** Emitted when the form is loaded or reloaded. */
@Output()
formLoaded: EventEmitter<FormModel> = new EventEmitter<FormModel>();
/** Emitted when form values are refreshed due to a data property change. */
@Output()
formDataRefreshed: EventEmitter<FormModel> = new EventEmitter<FormModel>();
/** Emitted when any outcome is executed. Default behaviour can be prevented
* via `event.preventDefault()`.
*/
@Output()
executeOutcome: EventEmitter<FormOutcomeEvent> = new EventEmitter<FormOutcomeEvent>();
/** Emitted when any error occurs. */
@Output()
onError: EventEmitter<any> = new EventEmitter<any>();

3
lib/core/info-drawer/info-drawer.component.ts
View File

@@ -34,12 +34,15 @@ export class InfoDrawerTabComponent {
host: { 'class': 'adf-info-drawer' }
})
export class InfoDrawerComponent {
/** The title of the info drawer. */
@Input()
title: string|null = null;
/** The selected index tab. */
@Input()
selectedIndex: number = 0;
/** Emitted when the currently active tab changes. */
@Output()
currentTab: EventEmitter<number> = new EventEmitter<number>();

28
lib/core/login/components/login.component.ts
View File

@@ -55,61 +55,61 @@ export class LoginComponent implements OnInit {
isPasswordShow: boolean = false;
/* Should the `Remember me` checkbox be shown? */
/** Should the `Remember me` checkbox be shown? */
@Input()
showRememberMe: boolean = true;
/* Should the extra actions (`Need Help`, `Register`, etc) be shown? */
/** 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 */
/** Sets the URL of the NEED HELP link in the footer. */
@Input()
needHelpLink: string = '';
/* Sets the URL of the REGISTER link in the footer */
/** Sets the URL of the REGISTER link in the footer. */
@Input()
registerLink: string = '';
/* Path to a custom logo image */
/** Path to a custom logo image. */
@Input()
logoImageUrl: string = './assets/images/alfresco-logo.svg';
/* Path to a custom background image */
/** Path to a custom background image. */
@Input()
backgroundImageUrl: string = './assets/images/background.svg';
/* The copyright text below the login box */
/** 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
/** 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 */
/** Custom validation rules for the login form. */
@Input()
fieldsValidation: any;
/* Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
/** Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
@Input()
disableCsrf: boolean;
/* Route to redirect to on successful login. */
/** Route to redirect to on successful login. */
@Input()
successRoute: string = null;
/* Emitted when the login is successful */
/** Emitted when the login is successful. */
@Output()
success = new EventEmitter<LoginSuccessEvent>();
/* Emitted when the login fails */
/** Emitted when the login fails. */
@Output()
error = new EventEmitter<LoginErrorEvent>();
/* Emitted when the login form is submitted */
/** Emitted when the login form is submitted. */
@Output()
executeSubmit = new EventEmitter<LoginSubmitEvent>();

5
lib/core/pagination/infinite-pagination.component.ts
View File

@@ -50,18 +50,23 @@ export class InfinitePaginationComponent implements OnInit, OnDestroy {
hasMoreItems: false
};
/** Pagination object. */
@Input()
pagination: Pagination;
/** Component that provides custom pagination support. */
@Input()
target: PaginatedComponent;
/** Number of items that are added with each "load more" event. */
@Input()
pageSize: number = InfinitePaginationComponent.DEFAULT_PAGE_SIZE;
/** Is a new page loading? */
@Input('loading')
isLoading: boolean = false;
/** Emitted when the "Load More" button is clicked. */
@Output()
loadMore: EventEmitter<Pagination> = new EventEmitter<Pagination>();

8
lib/core/pagination/pagination.component.ts
View File

@@ -56,27 +56,35 @@ export class PaginationComponent implements OnInit, OnDestroy {
CHANGE_PAGE_NUMBER: 'CHANGE_PAGE_NUMBER'
};
/** Component that provides custom pagination support. */
@Input()
target: PaginatedComponent;
/** An array of page sizes. */
@Input()
supportedPageSizes: number[] = [5, 25, 50, 100];
/** Pagination object. */
@Input()
pagination: Pagination;
/** Emitted when paginaton changes in any way. */
@Output()
change: EventEmitter<PaginationQueryParams> = new EventEmitter<PaginationQueryParams>();
/** Emitted when the page number changes. */
@Output()
changePageNumber: EventEmitter<Pagination> = new EventEmitter<Pagination>();
/** Emitted when the page size changes. */
@Output()
changePageSize: EventEmitter<Pagination> = new EventEmitter<Pagination>();
/** Emitted when the next page is requested. */
@Output()
nextPage: EventEmitter<Pagination> = new EventEmitter<Pagination>();
/** Emitted when the previous page is requested. */
@Output()
prevPage: EventEmitter<Pagination> = new EventEmitter<Pagination>();

2
lib/core/settings/host-settings.component.ts
View File

@@ -42,9 +42,11 @@ export class HostSettingsComponent {
urlFormControlEcm = new FormControl('', [Validators.required, Validators.pattern(this.HOST_REGEX)]);
urlFormControlBpm = new FormControl('', [Validators.required, Validators.pattern(this.HOST_REGEX)]);
/** Determines which configurations are shown. Possible valid values are "ECM", "BPM" or "ALL". */
@Input()
providers: string = 'ALL';
/** Emitted when the URL is invalid. */
@Output()
error = new EventEmitter<string>();