alfresco-ng2-components/docs/create-process-attachment.component.md
Andy Stark c9a3b048b4 [ADF-1769] Added JSDocs and updated prop table script (#2838)
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
2018-01-17 17:11:22 +00:00

29 lines
976 B
Markdown

# Create Process Attachment component
Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance
![process-create-attachment](docassets/images/process-create-attachment.png)
## Basic Usage
```html
<adf-create-process-attachment
[processInstanceId]="YOUR_PROCESS_INSTANCE_ID"
(error)="YOUR_CREATE_ATTACHMENT_ERROR_HANDLER"
(success)="YOUR_CREATE_ATTACHMENT_SUCCESS_HANDLER">
</adf-create-process-attachment>
```
### Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| processInstanceId | `string` | (required) The ID of the process instance to display. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | `EventEmitter<any>` | Emitted when an attachment is successfully created or uploaded from within the component. |