[ADF-4152] Updated doc folder structure and index tool (#4403)

* [ADF-4152] Initial GraphQL implementation * [ADF-4152] Schema updates * [ADF-4152] Rounded out basic fields * [ADF-4152] Added basic template functionality * [ADF-4152] Added full template generation * [ADF-4152] Moved proc services doc files to new folders * [ADF-4152] Updated README.md with section from new template * [ADF-4152] Fixed another problem with relative URLs * [ADF-4152] Fixed links and some more bugs * [ADF-4152] Removed proc services folder README file
2025-07-24 17:32:15 +00:00 · 2019-03-06 20:23:31 +00:00
parent 75b90c5e08
commit e74f545aa8
48 changed files with 1180 additions and 461 deletions
--- a/docs/process-services/components/process-attachment-list.component.md
+++ b/docs/process-services/components/process-attachment-list.component.md
@@ -0,0 +1,104 @@
+---
+Title: Process Attachment List component
+Added: v2.0.0
+Status: Active
+Last reviewed: 2019-01-14
+---
+
+# [Process Attachment List component](../../../lib/process-services/attachment/process-attachment-list.component.ts "Defined in process-attachment-list.component.ts")
+
+Displays documents attached to 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>
+```
+
+Make sure to override the [`UploadService`](../../core/upload.service.md) with the [`ProcessUploadService`](../../../lib/process-services/task-list/services/process-upload.service.ts)
+
+```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() {}
+}
+```
+
+### [Transclusions](../../user-guide/transclusion.md)
+
+Any content inside the `<adf-process-attachment-list>` element will be shown when
+the list is empty:
+
+```html
+<adf-process-attachment-list ...>
+    <div><!-- Custom empty list message goes here --></div>
+</adf-process-attachment-list>
+```
+
+![custom-no-content-drag-drop-template-sample](../../docassets/images/custom-no-content-drag-drop-template.png)
+
+A default template will be used if you don't supply a custom one to override it:
+
+![default-no-content-template-sample](../../docassets/images/default-no-content-template.png)
+
+## Class members
+
+### Properties
+
+| Name | Type | Default value | Description |
+| ---- | ---- | ------------- | ----------- |
+| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. |
+| processInstanceId | `string` |  | (**required**) The ID of the process instance to display. |
+
+### Events
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | 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`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. |
+| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
+
+## Details
+
+### How to Add Drag and Drop Functionality
+
+You can wrap the attachment list with an
+[Upload Drag Area component](../../content-services/upload-drag-area.component.md)
+to let the user upload attachments to empty lists. When you do this, you can also supply
+a custom _no content template_ (using &lt;adf-empty-list>) to invite the user to add their attachments:
+
+<!-- {% raw %} -->
+
+```html
+<adf-upload-drag-area
+    [rootFolderId]="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>
+```
+
+<!-- {% endraw %} -->