inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added prop tables and JSDocs (#2906)

Browse Source
This commit is contained in:
Andy Stark
2018-02-02 14:56:59 +00:00
committed by Eugenio Romano
parent 819274301b
commit 5ee9b09a21
14 changed files with 132 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/start-process.component.md
+6 -7
View File
@@ -15,21 +15,21 @@ Starts a process.
### Properties
| Name | Type | Description |
| ---- | -- | ----------- |
| ---- | ---- | ----------- |
| appId | `number` | (optional): Limit the list of processes which can be started to those contained in the specified app |
| name | `string` | (optional) name to assign to the current process |
| processDefinitionName | `string` | (optional) definition name of the process to start |
| variables | `ProcessInstanceVariable[]` |Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
| variables | `ProcessInstanceVariable[]` | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
| values | `FormValues` | Parameter to pass form field values in the start form if is associated |
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
### Events
| Name | Type | Description |
| ---- | -- | --------- |
| ---- | ---- | ----------- |
| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts |
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled |
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails |
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled |
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails |
### Start a process with a default name and pre-selected process definition name
@@ -53,7 +53,6 @@ If your app has more than one process definition, with the property processDefin
With the property processDefinitionName you can select as dropdown default value your PROCESS_DEFINITION_NAME.
### Custom data example
Here is an example of how to pass in form field values to initialize the start form that has been