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 JSDocs and updated prop table script (#2838)

Browse Source 
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
This commit is contained in:
Andy Stark
2018-01-17 17:11:22 +00:00
committed by Eugenio Romano
parent 3461749dc6
commit c9a3b048b4
25 changed files with 194 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/content-services/breadcrumb/breadcrumb.component.ts
View File

@@ -30,15 +30,26 @@ import { DocumentListComponent } from '../document-list';
})
export class BreadcrumbComponent implements OnChanges {
/** Active node, builds UI based on folderNode.path.elements collection. */
@Input()
folderNode: MinimalNodeEntryEntity = null;
/** (optional) Name of the root element of the breadcrumb. You can use
* this property to rename "Company Home" to "Personal Files" for
* example. You can use an i18n resource key for the property value.
*/
@Input()
root: string = null;
/** (optional) The id of the root element. You can use this property
* to set a custom element the breadcrumb should start with.
*/
@Input()
rootId: string = null;
/** (optional) Document List component to operate with. The list will
* update when the breadcrumb is clicked.
*/
@Input()
target: DocumentListComponent;
@@ -48,6 +59,7 @@ export class BreadcrumbComponent implements OnChanges {
return !!this.root;
}
/** Emitted when the user clicks on a breadcrumb. */
@Output()
navigate: EventEmitter<PathElementEntity> = new EventEmitter<PathElementEntity>();

15
lib/content-services/document-list/components/content-action/content-action.component.ts
View File

@@ -35,36 +35,51 @@ import { ContentActionListComponent } from './content-action-list.component';
})
export class ContentActionComponent implements OnInit, OnChanges {
/** The title of the action as shown in the menu. */
@Input()
title: string = 'Action';
/** The name of the icon to display next to the menu command (can be left blank). */
@Input()
icon: string;
/** System actions. Can be "delete", "download", "copy" or "move". */
@Input()
handler: string;
/** Type of item that the action appies to. Can be "document" or "folder" */
@Input()
target: string;
/** The permission type. */
@Input()
permission: string;
/** Should this action be disabled in the menu if the user doesn't have permission for it? */
@Input()
disableWithNoPermission: boolean;
/** Is the menu item disabled? */
@Input()
disabled: boolean = false;
/** Emitted when the user selects the action from the menu. */
@Output()
execute = new EventEmitter();
/** Emitted when a permission error occurs */
@Output()
permissionEvent = new EventEmitter();
/** Emitted when an error occurs during the action.
* Applies to copy and move actions.
*/
@Output()
error = new EventEmitter();
/** Emitted when the action succeeds with the success string message.
* Applies to copy, move and delete actions.
*/
@Output()
success = new EventEmitter();