inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/accordion-group.component.md
View File

@ -33,11 +33,18 @@ export class MyComponent implements OnInit {
| Name | Type | Description |
| ---- | ---- | ----------- |
| heading | string | Title heading for the group. |
| isSelected | boolean | Is this group currently selected? |
| headingIcon | string | The material design icon. |
| hasAccordionIcon | boolean | Should the (expanded) accordion icon be shown? Defaults to true |
| headingIconTooltip | string | Tooltip message to be shown for headingIcon |
| heading | `string` | Title heading for the group. |
| headingIcon | `string` | The material design icon. |
| headingIconTooltip | `string` | Tooltip message to be shown for headingIcon |
| hasAccordionIcon | `boolean` | Should the (expanded) accordion icon be shown? <br/> Default value: `true` |
| isOpen | `boolean` | Is this group currently open? |
| isSelected | `boolean` | Is this group currently selected? |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| headingClick | `EventEmitter<any>` | Emitted when the heading is clicked. |
## Details

9
docs/accordion.component.md
View File

@ -29,15 +29,6 @@ export class MyComponent implements OnInit {
}
```
### Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| heading | string | The header title. |
| isSelected | boolean | Define if the accordion group is selected or not. |
| headingIcon | string | The material design icon. |
| hasAccordionIcon | boolean | Define if the accordion (expand) icon needs to be shown or not, the default value is true |
## Details
An accordion menu contains several panels of content, only one of which is visible at any time. The

15
docs/apps-list.component.md
View File

@ -1,4 +1,4 @@
# Activiti Apps Component
# Apps List Component
Shows all available apps.
@ -15,15 +15,16 @@ Shows all available apps.
### Properties
| Name | Type | Description |
| --- | --- | --- |
| layoutType | string | (**required**) Define the layout of the apps. There are two possible values: GRID or LIST. |
| filtersAppId | Object | Provide a way to filter the apps to show. |
| ---- | ---- | ----------- |
| layoutType | `string` | (\*\*required\*\*) Defines the layout of the apps. There are two possible values, "GRID" and "LIST".<br/> Default value: `AppsListComponent.LAYOUT_GRID` |
| filtersAppId | `any[]` | Provides a way to filter the apps to show. |
### Events
| Name | Description |
| --- | --- |
| appClick | Raised when an app entry is clicked |
| Name | Type | Description |
| ---- | ---- | ----------- |
| appClick | `EventEmitter<AppDefinitionRepresentationModel>` | Emitted when an app entry is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details

14
docs/breadcrumb.component.md
View File

@ -17,16 +17,16 @@ Indicates the current position within a navigation hierarchy.
| Name | Type | Description |
| ---- | ---- | ----------- |
| target | DocumentListComponent | (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update. |
| folderNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | Active node, builds UI based on `folderNode.path.elements` collection. |
| root | string | (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 i18n resource key for the property value. |
| rootId | string | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| folderNode | `MinimalNodeEntryEntity` | Active node, builds UI based on folderNode.path.elements collection. <br/> Default value: `null` |
| root | `string` | (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.<br/> Default value: `null` |
| rootId | `string` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with.<br/> Default value: `null` |
| target | `DocumentListComponent` | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
### Events
| Name | Returned Type | Description |
| ---- | ------------- | ----------- |
| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb |
| Name | Type | Description |
| ---- | ---- | ----------- |
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
## See also

18
docs/checklist.component.md
View File

@ -1,4 +1,4 @@
# Activiti Checklist Component
# Checklist Component
Shows the checklist task functionality.
@ -15,7 +15,15 @@ Shows the checklist task functionality.
### Properties
| Name | Type | Description |
| --- | --- | --- |
| taskId | string | (**required**) The id of the parent task which sub tasks are attached on. |
| readOnlyForm | boolean | Toggle readonly state of the form. Enforces all form widgets render readonly if enabled. |
| assignee | string | (**required**) The assignee id where the subtasks are assigned to. |
| ---- | ---- | ----------- |
| taskId | `string` | (required) The id of the parent task to which subtasks are attached. |
| readOnly | `boolean` | Toggle readonly state of the form. All form widgets will render as readonly if enabled.<br/> Default value: `false` |
| assignee | `string` | (required) The assignee id that the subtasks are assigned to. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| checklistTaskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a new checklist task is created. |
| checklistTaskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |

12
docs/comment-list.component.md
View File

@ -54,12 +54,12 @@ In the component template use the comment list component:
### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| comments | CommentProcessModel\[] | | The comments data used to populate the list |
| Name | Type | Description |
| ---- | ---- | ----------- |
| comments | `any[]` | The comments data used to populate the list. |
### Events
| Name | Description |
| ---- | ----------- |
| clickRow | Emitted when the user clicks on one of the comment rows |
| Name | Type | Description |
| ---- | ---- | ----------- |
| clickRow | `EventEmitter<any>` | Emitted when the user clicks on one of the comment rows. |

14
docs/comments.component.md
View File

@ -1,4 +1,4 @@
# ADF Comments Component
# Comments Component
Displays comments from users involved in a specified task and allows an involved user to add a comment to the task.
@ -16,12 +16,12 @@ Displays comments from users involved in a specified task and allows an involved
### Properties
| Name | Type | Description |
| --- | --- | --- |
| taskId | string | The numeric ID of the task |
| readOnly | boolean | The boolean flag |
| ---- | ---- | ----------- |
| taskId | `string` | The numeric ID of the task. |
| readOnly | `boolean` | Are the comments read only? <br/> Default value: `false` |
### Events
| Name | Description |
| --- | --- |
| error | Raised when an error occurs while displaying/adding a comment |
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when an error occurs while displaying/adding a comment. |

30
docs/content-action.component.md
View File

@ -74,24 +74,24 @@ export class MyView {
### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `target` | string | | "document" or "folder" |
| `title` | string | | The title of the action as shown in the menu |
| `icon` | string | | The name of the icon to display next to the menu command (can be left blank) |
| `handler` | string | | System type actions. Can be "delete", "download", "copy" or "move" |
| `permission` | string | | The name of the permission |
| `disabled` | boolean | | Is the menu item disabled? |
| `disableWithNoPermission` | boolean | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| Name | Type | Description |
| ---- | ---- | ----------- |
| title | `string` | The title of the action as shown in the menu. <br/> Default value: `'Action'` |
| icon | `string` | The name of the icon to display next to the menu command (can be left blank). |
| handler | `string` | System actions. Can be "delete", "download", "copy" or "move". |
| target | `string` | Type of item that the action appies to. Can be "document" or "folder" |
| permission | `string` | The permission type. |
| disableWithNoPermission | `boolean` | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean` | Is the menu item disabled? <br/> Default value: `false` |
### Events
| Name | Handler | Description |
| ---- | ------- | ----------- |
| `execute` | All | Emitted when user clicks on the action. For combined handlers see below |
| `permissionEvent` | All | Emitted when a permission error happens |
| `success` | copy, move, delete | Emitted on successful action with the success string message |
| `error` | copy, move | Emitted on unsuccessful action with the error event |
| Name | Type | Description |
| ---- | ---- | ----------- |
| execute | `EventEmitter<{}>` | Emitted when the user selects the action from the menu. |
| permissionEvent | `EventEmitter<{}>` | Emitted when a permission error occurs |
| error | `EventEmitter<{}>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| success | `EventEmitter<{}>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details

12
docs/create-process-attachment.component.md
View File

@ -17,12 +17,12 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
### Properties
| Name | Type | Description |
| --- | --- | --- |
| processInstanceId | string | (**required**): The ID of the process instance to display |
| ---- | ---- | ----------- |
| processInstanceId | `string` | (required) The ID of the process instance to display. |
### Events
| Name | Description |
| --- | --- |
| error | Raised when the error occurred while creating/uploading the attachment by the user from within the component |
| success | Raised when the attachment created/uploaded successfully from within the component |
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | `EventEmitter<any>` | Emitted when an attachment is successfully created or uploaded from within the component. |

4
docs/create-task-attachment.component.md
View File

@ -17,12 +17,12 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
### Properties
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| taskId | string | (**required**): The numeric ID of the task to display |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| error | Raised when the error occurred while creating/uploading the attachment by the user from within the component |
| success | Raised when the attachment created/uploaded successfully from within the component |

21
docs/data-column.component.md
View File

@ -33,17 +33,16 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| key | string | | Data source key, can be either column/property key like `title` or property path like `createdBy.name` |
| type | string | text | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'. |
| format | string | | Value format (if supported by components), for example format of the date |
| sortable | boolean | true | Toggles ability to sort by this column, for example by clicking the column header |
| title | string | | Display title of the column, typically used for column headers. You can use the i18n resouce key to get it translated automatically. |
| template | `TemplateRef` | | Custom column template |
| sr-title | string | | Screen reader title, used for accessibility purposes |
| class | string | | Additional CSS class to be applied to column (header and cells) |
| formatTooltip | Function | | Custom tooltip formatter function. |
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | `string` | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
| type | `string` | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'.<br/> Default value: `'text'` |
| format | `string` | Value format (if supported by the parent component), for example format of the date. |
| sortable | `boolean` | Toggles ability to sort by this column, for example by clicking the column header. <br/> Default value: `true` |
| title | `string` | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically.<br/> Default value: `''` |
| formatTooltip | `Function` | Custom tooltip formatter function. |
| srTitle | `string` | Title to be used for screen readers. |
| cssClass | `string` | Additional CSS class to be applied to column (header and cells). |
## Details

8
docs/document-list.component.md
View File

@ -54,17 +54,17 @@ Displays the documents from a repository.
| navigate | `boolean` | Toggles navigation to folder content or file preview <br/> Default value: `true` |
| navigationMode | `string` | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". <br/> Default value: `DocumentListComponent.DOUBLE_CLICK_NAVIGATION` |
| thumbnails | `boolean` | Show document thumbnails rather than icons <br/> Default value: `false` |
| selectionMode | `string` | Row selection mode. Can be null, \`single\` or \`multiple\`. For \`multiple\` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.<br/> Default value: `'single'` |
| selectionMode | `string` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.<br/> Default value: `'single'` |
| multiselect | `boolean` | Toggles multiselect mode <br/> Default value: `false` |
| contentActions | `boolean` | Toggles content actions for each row <br/> Default value: `false` |
| contentActionsPosition | `string` | Position of the content actions dropdown menu. Can be set to "left" or "right". <br/> Default value: `'right'` |
| contextMenuActions | `boolean` | Toggles context menus for each row <br/> Default value: `false` |
| emptyFolderImageUrl | `string` | Custom image for empty folder <br/> Default value: `'./assets/images/empty_doc_lib.svg'` |
| allowDropFiles | `boolean` | Toggle file drop support for rows (see Upload Directive for further details <br/> Default value: `false` |
| sorting | `string[]` | Defines default sorting. The format is an array of 2 strings \`\[key, direction]\` i.e. \`\['name', 'desc']\` or \`\['name', 'asc']\`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sorting | `string[]` | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| rowStyle | `string` | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
| rowStyleClass | `string` | The CSS class to apply to every row |
| loading | `boolean` | Toggles the loading state and animated spinners for the component. Used in combination with \`navigate=false\` to perform custom navigation and loading state indication.<br/> Default value: `false` |
| loading | `boolean` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication.<br/> Default value: `false` |
| rowFilter | `any` | Custom row filter <br/> Default value: `null` |
| imageResolver | `any` | Custom image resolver <br/> Default value: `null` |
| currentFolderId | `string` | The ID of the folder node to display or a reserved string alias for special sources <br/> Default value: `null` |
@ -81,7 +81,7 @@ Displays the documents from a repository.
| nodeClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user clicks a list node |
| nodeDblClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user double-clicks a list node |
| folderChange | `EventEmitter<NodeEntryEvent>` | Emitted when the current display folder changes |
| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on \`navigation-mode\`). Useful for integration with the Viewer component. |
| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. |
| ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
| error | `EventEmitter<any>` | Emitted when the API fails to get the Document List data |

16
docs/dropdown-breadcrumb.component.md
View File

@ -16,22 +16,24 @@ Indicates the current position within a navigation hierarchy using a dropdown me
### Properties
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| target | DocumentListComponent | (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update. |
| folderNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | Active node, builds UI based on `folderNode.path.elements` collection. |
| root | string | (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 i18n resource key for the property value. |
| root | string | (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 i18n resource key for the property value. |
| rootId | string | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
### Events
| Name | Returned Type | Description |
| --- | --- | --- |
| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb |
| ---- | ------------- | ----------- |
| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Document list component](document-list.component.md)
- [Breadcrumb component](breadcrumb.component.md)
<!-- seealso end -->
- [Document list component](document-list.component.md)
- [Breadcrumb component](breadcrumb.component.md)
<!-- seealso end -->

9
lib/config/DocProcessor/tools/tscProps.js
View File

@ -3,6 +3,7 @@ exports.__esModule = true;
var ts = require("typescript");
var path = require("path");
var heading = require("mdast-util-heading-range");
var remark = require("remark");
var unist = require("../unistHelpers");
function initPhase(aggData) {
}
@ -84,7 +85,9 @@ function getPropDataFromClass(checker, classDec, inputs, outputs) {
var sourceFile = classDec.getSourceFile();
for (var i = 0; i < classDec.members.length; i++) {
var member = classDec.members[i];
if (ts.isPropertyDeclaration(member)) {
if (ts.isPropertyDeclaration(member) ||
ts.isGetAccessorDeclaration(member) ||
ts.isSetAccessorDeclaration(member)) {
var prop = member;
var mods = ts.getCombinedModifierFlags(prop);
var nonPrivate = (mods & ts.ModifierFlags.Private) === 0;
@ -139,7 +142,7 @@ function buildInputsTable(inputs) {
//pDesc = pDesc.trim().replace(/[\n\r]+/, " ");
pDesc = pDesc.replace(/[\n\r]+/, " ");
}
var descCellContent = [unist.makeText(pDesc)];
var descCellContent = remark().parse(pDesc).children;
if (pDefault) {
descCellContent.push(unist.makeHTML("<br/>"));
descCellContent.push(unist.makeText(" Default value: "));
@ -176,7 +179,7 @@ function buildOutputsTable(outputs) {
var cells = [
unist.makeTableCell([unist.makeText(eName)]),
unist.makeTableCell([unist.makeInlineCode(eType)]),
unist.makeTableCell([unist.makeText(eDesc)])
unist.makeTableCell(remark().parse(eDesc).children)
];
rows.push(unist.makeTableRow(cells));
}

9
lib/config/DocProcessor/tools/tscProps.ts
View File

@ -4,6 +4,7 @@ import * as path from "path";
import * as program from "commander";
import * as heading from "mdast-util-heading-range";
import * as remark from "remark";
import * as unist from "../unistHelpers";
import { JsxEmit } from "typescript";
@ -121,7 +122,9 @@ function getPropDataFromClass(
for (var i = 0; i < classDec.members.length; i++) {
let member = classDec.members[i];
if (ts.isPropertyDeclaration(member)) {
if (ts.isPropertyDeclaration(member) ||
ts.isGetAccessorDeclaration(member) ||
ts.isSetAccessorDeclaration(member)) {
let prop: ts.PropertyDeclaration = member;
let mods = ts.getCombinedModifierFlags(prop);
@ -188,7 +191,7 @@ function buildInputsTable(inputs: any[]) {
pDesc = pDesc.replace(/[\n\r]+/, " ");
}
var descCellContent = [unist.makeText(pDesc)];
var descCellContent = remark().parse(pDesc).children;
if (pDefault) {
descCellContent.push(unist.makeHTML("<br/>"));
@ -235,7 +238,7 @@ function buildOutputsTable(outputs: any[]) {
var cells = [
unist.makeTableCell([unist.makeText(eName)]),
unist.makeTableCell([unist.makeInlineCode(eType)]),
unist.makeTableCell([unist.makeText(eDesc)])
unist.makeTableCell(remark().parse(eDesc).children)
];
rows.push(unist.makeTableRow(cells));

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();

7
lib/core/collapsable/accordion-group.component.ts
View File

@ -31,21 +31,27 @@ export class AccordionGroupComponent implements OnDestroy {
@ViewChild('contentWrapper')
contentWrapper: any;
/** Title heading for the group. */
@Input()
heading: string;
/** The material design icon. */
@Input()
headingIcon: string;
/** Tooltip message to be shown for headingIcon */
@Input()
headingIconTooltip: string;
/** Should the (expanded) accordion icon be shown? */
@Input()
hasAccordionIcon: boolean = true;
/** Emitted when the heading is clicked. */
@Output()
headingClick: EventEmitter<any> = new EventEmitter<any>();
/** Is this group currently open? */
@Input()
set isOpen(value: boolean) {
this._isOpen = value;
@ -58,6 +64,7 @@ export class AccordionGroupComponent implements OnDestroy {
return this._isOpen;
}
/** Is this group currently selected? */
@Input()
set isSelected(value: boolean) {
this._isSelected = value;

17
lib/core/data-column/data-column.component.ts
View File

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

6
lib/process-services/app-list/apps-list.component.ts
View File

@ -37,15 +37,21 @@ export class AppsListComponent implements OnInit {
public static DEFAULT_TASKS_APP_ICON: string = 'glyphicon-asterisk';
public static DEFAULT_TASKS_APP_MATERIAL_ICON: string = 'favorite_border';
/** (**required**) Defines the layout of the apps. There are two possible
* values, "GRID" and "LIST".
*/
@Input()
layoutType: string = AppsListComponent.LAYOUT_GRID;
/** Provides a way to filter the apps to show. */
@Input()
filtersAppId: any[];
/** Emitted when an app entry is clicked. */
@Output()
appClick: EventEmitter<AppDefinitionRepresentationModel> = new EventEmitter<AppDefinitionRepresentationModel>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();

7
lib/process-services/attachment/create-process-attachment.component.ts
View File

@ -25,12 +25,19 @@ import { ProcessContentService } from '@alfresco/adf-core';
})
export class CreateProcessAttachmentComponent implements OnChanges {
/** (required) The ID of the process instance to display. */
@Input()
processInstanceId: string;
/** Emitted when an error occurs while creating or uploading an attachment
* from the user within the component.
*/
@Output()
error: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an attachment is successfully created or uploaded
* from within the component.
*/
@Output()
success: EventEmitter<any> = new EventEmitter<any>();

7
lib/process-services/attachment/create-task-attachment.component.ts
View File

@ -25,12 +25,19 @@ import { ProcessContentService } from '@alfresco/adf-core';
})
export class AttachmentComponent implements OnChanges {
/** (required) The numeric ID of the task to display. */
@Input()
taskId: string;
/** Emitted when an error occurs while creating or uploading an
* attachment from the user within the component.
*/
@Output()
error: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an attachment is created or uploaded successfully
* from within the component.
*/
@Output()
success: EventEmitter<any> = new EventEmitter<any>();

2
lib/process-services/comments/comment-list.component.ts
View File

@ -27,9 +27,11 @@ import { Component, EventEmitter, Input, Output } from '@angular/core';
export class CommentListComponent {
/** The comments data used to populate the list. */
@Input()
comments: CommentProcessModel[];
/** Emitted when the user clicks on one of the comment rows. */
@Output()
clickRow: EventEmitter<CommentProcessModel> = new EventEmitter<CommentProcessModel>();

3
lib/process-services/comments/comments.component.ts
View File

@ -27,12 +27,15 @@ import { Observer } from 'rxjs/Observer';
})
export class CommentsComponent implements OnChanges {
/** The numeric ID of the task. */
@Input()
taskId: string;
/** Are the comments read only? */
@Input()
readOnly: boolean = false;
/** Emitted when an error occurs while displaying/adding a comment. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();

10
lib/process-services/task-list/components/checklist.component.ts
View File

@ -30,21 +30,31 @@ import { TaskListService } from './../services/tasklist.service';
})
export class ChecklistComponent implements OnInit, OnChanges {
/** (required) The id of the parent task to which subtasks are
* attached.
*/
@Input()
taskId: string;
/** Toggle readonly state of the form. All form widgets
* will render as readonly if enabled.
*/
@Input()
readOnly: boolean = false;
/** (required) The assignee id that the subtasks are assigned to. */
@Input()
assignee: string;
/** Emitted when a new checklist task is created. */
@Output()
checklistTaskCreated: EventEmitter<TaskDetailsModel> = new EventEmitter<TaskDetailsModel>();
/** Emitted when a checklist task is deleted. */
@Output()
checklistTaskDeleted: EventEmitter<string> = new EventEmitter<string>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();