inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-08 14:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2764] Updated process services docs with latest features (#3390)

Browse Source
This commit is contained in:
Andy Stark
2018-05-24 17:10:35 +01:00
committed by Eugenio Romano
parent a2581417bd
commit 04e50eeabd
33 changed files with 576 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/process-services/task-details.component.md
View File

@@ -21,43 +21,43 @@ Shows the details of the task ID passed in as input.
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| debugMode | `boolean` | `false` | Toggles debug mode. |
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
| showNextTask | `boolean` | `true` | Automatically renders the next task when the current one is completed. |
| showHeader | `boolean` | `true` | Toggles task details Header component. |
| showHeaderContent | `boolean` | `true` | Toggles collapsed/expanded state of the Header component. |
| showInvolvePeople | `boolean` | `true` | Toggles `Involve People` feature for the Header component. |
| showComments | `boolean` | `true` | Toggles `Comments` feature for the Header component. |
| showChecklist | `boolean` | `true` | Toggles `Checklist` feature for the Header component. |
| showFormTitle | `boolean` | `true` | Toggles rendering of the form title. |
| showFormCompleteButton | `boolean` | `true` | Toggles rendering of the `Complete` outcome button. |
| showFormSaveButton | `boolean` | `true` | Toggles rendering of the `Save` outcome button. |
| readOnlyForm | `boolean` | `false` | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
| showFormRefreshButton | `boolean` | `true` | Toggles rendering of the `Refresh` button. |
| fieldValidators | `any[]` | `[]` | Field validators for use with the form. |
| -- | -- | -- | -- |
| debugMode | `boolean` | false | Toggles debug mode. |
| fieldValidators | [`FormFieldValidator[]`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | \[] | Field validators for use with the form. |
| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. |
| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. |
| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. |
| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. |
| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. |
| showFormTitle | `boolean` | true | Toggles rendering of the form title. |
| showHeader | `boolean` | true | Toggles task details Header component. |
| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. |
| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. |
| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. |
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| formSaved | `EventEmitter<any>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| formCompleted | `EventEmitter<any>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | `EventEmitter<any>` | Emitted when the form field content is clicked. |
| formLoaded | `EventEmitter<any>` | Emitted when the form is loaded or reloaded. |
| taskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a checklist task is created. |
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| executeOutcome | `EventEmitter<any>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| assignTask | `EventEmitter<void>` | Emitted when a task is assigned. |
| claimedTask | `EventEmitter<string>` | Emitted when a task is claimed. |
| unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. |
| -- | -- | -- |
| assignTask | `EventEmitter<void>` | Emitted when a task is assigned. |
| claimedTask | `EventEmitter<string>` | Emitted when a task is claimed. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| executeOutcome | [`EventEmitter<FormOutcomeEvent>`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter<ContentLinkModel>`](../../lib/core/form/components/widgets/core/content-link.model.ts) | Emitted when the form field content is clicked. |
| formLoaded | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Save` or custom outcomes. |
| taskCreated | [`EventEmitter<TaskDetailsModel>`](../process-services/task-details.model.md) | Emitted when a checklist task is created. |
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. |
## Details
### Custom 'empty Task Details' template
By default the Task Details component shows a simple "No Tasks" message when there are
By default the [Task Details component](../process-services/task-details.component.md) shows a simple "No Tasks" message when there are
no details. You can change this by adding the a custom HTML template as in the following
example: