alfresco-ng2-components/docs/process-attachment-list.component.md

Process Attachment List component

Displays attached documents on a specified process instance

Basic Usage

<adf-process-attachment-list
    [processInstanceId]="YOUR_PROCESS_INSTANCE_ID"
    (attachmentClick)="YOUR_ATTACHMENT_CLICK_EMITTER_HANDLER">
</adf-process-attachment-list>

If the List is empty, a default no content template is displayed.

Make sure to override the UploadService with the ProcessUploadService

import { UploadService } from '@alfresco/adf-core';
import { ProcessUploadService } from '@alfresco/adf-process-services';

@Component({
    selector: 'my-custom-process-attachment',
    providers: [
        { provide: UploadService, useClass: ProcessUploadService }
    ]
})
export class MyCustomProcessAttachmentComponent {
    constructor() {}
}

Properties

Name	Type	Default value	Description
processInstanceId	string		(required) The ID of the process instance to display.
disabled	boolean	false	Disable/Enable read-only mode for attachment list.

Events

Name	Type	Description
attachmentClick	EventEmitter<{}>	Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked.
success	EventEmitter<{}>	Emitted when the attachment list has fetched all the attachments. Returns a list of attachments.
error	EventEmitter<any>	Emitted when the attachment list is not able to fetch the attachments (eg, following a network error).

Details

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.

<adf-upload-drag-area
    [parentId]="YOUR_PROCESS_ID"
    [showNotificationBar]="BOOLEAN">
    <adf-process-attachment-list  
        [processId]="YOUR_PROCESS_ID"
        (attachmentClick)="YOUR_HANDLER">
            <div adf-empty-list> //no content template
                <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>
            </div>
    </adf-process-attachment-list>
</adf-upload-drag-area>

If the List is empty, the custom no-content template we passed is displayed.