mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1549] Added doc files for Tasklist library (#2350)
This commit is contained in:
committed by
Eugenio Romano
parent
7a31a16178
commit
a41afe0dbd
45
docs/task-audit.directive.md
Normal file
45
docs/task-audit.directive.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Task Audit Directive
|
||||
|
||||
Provides a way to fetch the Task Audit information in the pdf or json format.
|
||||
|
||||

|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<button
|
||||
adf-task-audit
|
||||
[task-id]="taskId"
|
||||
[download]="download"
|
||||
md-icon-button (clicked)="onAuditClick($event)" (error)="onAuditError($event)" >
|
||||
<md-icon>assignment_ind</md-icon>
|
||||
</button>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| taskId | string | | (**required**) The id of the task. |
|
||||
| format | string | pdf | In whitch format you want the task audit information (pdf or json). |
|
||||
| download | boolean | false | True If you want download the file on the click event. |
|
||||
| fileName | string | Audit | Represent the name of the file to download in case the format is pdf. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| clicked | Raised when the task audit info is ready |
|
||||
| error | Raised if there is an error during fetching task information |
|
Reference in New Issue
Block a user