mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ACA-30333]FE - [Process-services] Create ADF task form. (#5611)
* [ACA-3033] FE - [Process-services] Create ADF task form. * * Modifed task-from-template * * Refactored details component with the task-form * * Updated unit tests to the recent changes * * Modified task-details component * * Fixed failing tests * * Fixed failing tests* Added doc * * Fixed task-details-form e2e * Fixed failing test on tas-details e2e * * Fixed flaky process-services e2e * * Fixed flaky e2e tests
This commit is contained in:
54
docs/process-services/components/task-form.component.md
Normal file
54
docs/process-services/components/task-form.component.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
Title: Task Form component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2020-04-21
|
||||
---
|
||||
|
||||
# [Task Form component](../../../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts "Defined in task-form.component.ts")
|
||||
|
||||
Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) for a task.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-task-form
|
||||
[taskId]="taskId">
|
||||
</adf-task-form>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| 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. |
|
||||
| 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` | false | Toggles rendering of the form title. |
|
||||
| showCancelButton | `boolean` | true | Toggles rendering of the `Cancel` empty form button. |
|
||||
| showFormValidationIcon | `boolean` | true | Toggle rendering of the validation icon
|
||||
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
|
||||
| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the task is completed. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
|
||||
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/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`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. |
|
||||
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
|
||||
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
|
||||
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
|
||||
## See also
|
||||
|
||||
- [Form component](./form.component.md)
|
||||
- [Form field model](../../core/models/form-field.model.md)
|
||||
- [Form service](../../core/services/form.service.md)
|
Reference in New Issue
Block a user