mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
89 lines
2.9 KiB
Markdown
89 lines
2.9 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-03-13
|
|
---
|
|
# 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>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| taskId | `string` | | (**required**) The ID of the task to display. |
|
|
| disabled | `boolean` | `false` | Disable/Enable read only mode for attachement list. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a Blob representing the clicked object. |
|
|
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
|
|
| error | `EventEmitter<any>` | Emitted when an error occurs while fetching the attachments. |
|
|
|
|
## Details
|
|
|
|
If the List is empty, a default "no content" template is displayed.
|
|
|
|
|
|
|
|
### How to Add Drag and Drop Functionality
|
|
|
|
You can wrap the component with an [Upload Drag Area component](../content-services/upload-drag-area.component.md)
|
|
to enable the user to upload attachments for empty lists. When you do this, you can also pass
|
|
a custom _no content template_ as shown below. The component invites 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>
|
|
```
|
|
|
|
```ts
|
|
import { UploadService } from '@alfresco/adf-core';
|
|
import { TaskUploadService } from '@alfresco/adf-process-services';
|
|
```
|
|
|
|
Make sure you 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](../content-services/upload-drag-area.component.md)
|
|
|
|
If the List is empty, the custom no-content template we passed is displayed.
|
|
|
|
 |