mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
76 lines
2.6 KiB
Markdown
76 lines
2.6 KiB
Markdown
# Task Attachment List Component
|
|
|
|
Displays attached documents on a specified task.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-task-attachment-list
|
|
[taskId]="YOUR_TASK_ID"
|
|
(attachmentClick)="YOUR_HANDLER">
|
|
</adf-task-attachment-list>
|
|
```
|
|
If the List is empty, a default no content template is displayed.
|
|
|
|
|
|
|
|
### How to Add Drag and Drop Functionality
|
|
|
|
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom *no content template* as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
|
|
|
```html
|
|
<adf-upload-drag-area
|
|
[parentId]="YOUR_TASK_ID"
|
|
[showNotificationBar]="BOOLEAN">
|
|
<adf-task-attachment-list
|
|
[taskId]="YOUR_TASK_ID"
|
|
(attachmentClick)="YOUR_HANDLER">
|
|
<adf-empty-list>
|
|
<div adf-empty-list-header>{{This List is empty}}</div>
|
|
<div adf-empty-list-body>{{Drag and drop to upload}}</div>
|
|
<div adf-empty-list-footer>
|
|
<img [src]="Your custom image URL"></div>
|
|
</adf-empty-list>
|
|
</adf-task-attachment-list>
|
|
</adf-upload-drag-area>
|
|
```
|
|
|
|
import { UploadService } from '@alfresco/adf-core';
|
|
import { TaskUploadService } from '@alfresco/adf-process-services';
|
|
|
|
Make sure to override the UploadService with the TaskUploadService
|
|
```ts
|
|
@Component({
|
|
selector: 'my-custom-task-attachment',
|
|
providers: [
|
|
{ provide: UploadService, useClass: TaskUploadService }
|
|
]
|
|
})
|
|
export class MyCustomTaskAttachmentComponent {
|
|
constructor() {}
|
|
}
|
|
```
|
|
|
|
[Upload Drag Area Component](./upload-drag-area.component.md)
|
|
|
|
If the List is empty, the custom no-content template we passed is displayed.
|
|
|
|
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| taskId | string | (**required**): The ID of the task to display |
|
|
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
|
|
|
|
### Events
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| attachmentClick | Raised when the attachment double clicked or selected view option from context menu by the user from within the component and return a Blob obj of the object clicker|
|
|
| success | Raised when the attachment list fetch all the attach and return a list of attachments |
|
|
| error | Raised when the attachment list is not able to fetch the attachments for example network error |
|