[ADF-2463] Moved doc files to subfolders (#3073)

2025-07-24 17:32:15 +00:00 · 2018-03-13 17:29:07 +00:00
parent 766bb082f5
commit 6dc758889f
34 changed files with 103 additions and 105 deletions
--- a/docs/process-services/process-attachment-list.component.md
+++ b/docs/process-services/process-attachment-list.component.md
@@ -0,0 +1,83 @@
+---
+Added: v2.0.0
+Status: Active
+---
+# Process Attachment List component
+
+Displays attached documents on a specified process instance
+
+![process-attachment-list-sample](../docassets/images/process-attachment-list.png)
+
+## Basic Usage
+
+```html
+<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.
+
+![default-no-content-template-sample](../docassets/images/default-no-content-template.png)
+
+Make sure to override the UploadService with the ProcessUploadService
+
+```ts
+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.
+
+```html
+<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.
+
+![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png)