mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Doc review updates (#3957)
* [ADF-3745] Updates for doc review * [ADF-3745] Corrected title for process list cloud doc page
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
4e3f6e942f
commit
aab19708a2
@@ -35,9 +35,7 @@ Creates and manages public shared links for files.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| baseShareUrl | `string` | | Prefix to add to the generated link. |
|
||||
| adf-share | [`MinimalNodeEntity`](../content-services/document-library.model.md) | | Node to share. |
|
||||
| isFile | `boolean` | false | bound to 'adfShare' exportAs |
|
||||
| isShared | `boolean` | false | bound to 'adfShare' exportAs |
|
||||
| node | [`MinimalNodeEntity`](../content-services/document-library.model.md) | | Node to share. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Added: v2.6.1
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# Rating component
|
||||
# Tree View component
|
||||
|
||||
Allow a user to show the folder and subfolders of a node in a tree view
|
||||
Shows the folder and subfolders of a node as a tree view.
|
||||
|
||||
|
||||
|
||||
@@ -23,10 +23,10 @@ Allow a user to show the folder and subfolders of a node in a tree view
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | Identifier of the node to apply the rating to. |
|
||||
| nodeId | `string` | | Identifier of the node to display. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<NodeEntry>` | Emitted when a node on the tree view is clicked |
|
||||
| nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. |
|
||||
|
||||
@@ -14,7 +14,7 @@ Shows and manages a login dialog.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-05-24
|
||||
Last reviewed: 2018-11-09
|
||||
---
|
||||
|
||||
# Process Instance List
|
||||
# Process Instance List Cloud component
|
||||
|
||||
Renders a list containing all the process instances matched by the parameters specified.
|
||||
|
||||
@@ -49,24 +49,24 @@ when the process list is empty:
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| applicationName | `string` | | The name of the application. |
|
||||
| appVersion | `string` | | The application related version |
|
||||
| initiator | `string` | | the name of the initiator of the process |
|
||||
| id | `string` | | Filter the processes. Display only processes with id equal to the one insterted. |
|
||||
| name | `string` | | Filter the processes. Display only processes with name equal to the one insterted. |
|
||||
| processDefinitionId | `string` | | Filter the processes. Display only processes with processDefinitionId equal to the one insterted. |
|
||||
| processDefinitionKey | `string` | | Filter the processes. Display only processes with processDefinitionKey equal to the one insterted. |
|
||||
| serviceFullName | `string` | | Filter the processes. Display only processes with serviceFullName equal to the one insterted. |
|
||||
| serviceName | `string` | | Filter the processes. Display only processes with serviceName equal to the one insterted. |
|
||||
| serviceType | `string` | | Filter the processes. Display only processes with serviceType equal to the one insterted. |
|
||||
| serviceVersion | `string` | | Filter the processes. Display only processes with serviceVersion equal to the one insterted. |
|
||||
| status | `string` | | Filter the tasks. Display only processes with status equal to the one insterted. |
|
||||
| businessKey | `string` | | Filter the tasks. Display only processes with businessKey equal to the one insterted. |
|
||||
| selectFirstRow | `boolean` | true | Toggles default selection of the first row |
|
||||
| appVersion | `string` | "" | The related application version. |
|
||||
| applicationName | `string` | "" | The name of the application. |
|
||||
| businessKey | `string` | "" | Filter the tasks to display only the ones with this businessKey value. |
|
||||
| id | `string` | "" | Filter the processes to display only the ones with this ID. |
|
||||
| initiator | `string` | "" | Name of the initiator of the process. |
|
||||
| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. |
|
||||
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row |
|
||||
| sorting | `[ProcessListCloudSortingModel]` | | This array of `ProcessListCloudSortingModel` specify how the sorting on our table should be provided. This parameters are for BE sorting. |
|
||||
| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row |
|
||||
| name | `string` | "" | Filter the processes to display only the ones with this name. |
|
||||
| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. |
|
||||
| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. |
|
||||
| selectFirstRow | `boolean` | true | Toggles default selection of the first row |
|
||||
| selectionMode | `string` | "single" | Row selection mode. Can be "none", "single" or "multiple". For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| serviceFullName | `string` | "" | Filter the processes to display only the ones with this serviceFullName value. |
|
||||
| serviceName | `string` | "" | Filter the processes to display only the ones with this serviceName value. |
|
||||
| serviceType | `string` | "" | Filter the processes to display only the ones with this serviceType value. |
|
||||
| serviceVersion | `string` | "" | Filter the processes to display only the ones with this serviceVersion value. |
|
||||
| sorting | [`ProcessListCloudSortingModel`](../../lib/process-services-cloud/src/lib/process-list-cloud/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. |
|
||||
| status | `string` | "" | Filter the processes to display only the ones with this status. |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -75,7 +75,7 @@ when the process list is empty:
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
|
||||
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
|
||||
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected. |
|
||||
success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -151,10 +151,9 @@ information defined in `app.config.json` as in the example below:
|
||||
|
||||
### Setting Sorting Order for the list
|
||||
|
||||
you can pass sorting order as shown in the example below:
|
||||
You can specify a sorting order as shown in the example below:
|
||||
|
||||
```ts
|
||||
|
||||
let sorting = [{ orderBy: 'status', direction: 'desc' }];
|
||||
```
|
||||
|
||||
|
||||
@@ -35,6 +35,7 @@ export class NodeSharedDirective implements OnChanges {
|
||||
@Input('adf-share')
|
||||
node: MinimalNodeEntity;
|
||||
|
||||
/** Prefix to add to the generated link. */
|
||||
@Input()
|
||||
baseShareUrl: string;
|
||||
|
||||
|
||||
@@ -30,9 +30,11 @@ import { NodeEntry } from 'alfresco-js-api';
|
||||
|
||||
export class TreeViewComponent implements OnInit, OnChanges {
|
||||
|
||||
/** Identifier of the node to display. */
|
||||
@Input()
|
||||
nodeId: string;
|
||||
|
||||
/** Emitted when a node in the tree view is clicked. */
|
||||
@Output()
|
||||
nodeClicked: EventEmitter<NodeEntry> = new EventEmitter();
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ import { LoginSuccessEvent } from '../models/login-success.event';
|
||||
encapsulation: ViewEncapsulation.None
|
||||
})
|
||||
export class LoginDialogPanelComponent {
|
||||
|
||||
/** Emitted when the login succeeds. */
|
||||
@Output()
|
||||
success = new EventEmitter<LoginSuccessEvent>();
|
||||
|
||||
|
||||
@@ -22,70 +22,102 @@ export class ProcessListCloudComponent extends DataTableSchema implements OnChan
|
||||
@ContentChild(EmptyCustomContentDirective)
|
||||
emptyCustomContent: EmptyCustomContentDirective;
|
||||
|
||||
/** The name of the application. */
|
||||
@Input()
|
||||
applicationName: string = '';
|
||||
|
||||
/** The related application version. */
|
||||
@Input()
|
||||
appVersion: string = '';
|
||||
|
||||
/** Name of the initiator of the process. */
|
||||
@Input()
|
||||
initiator: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this ID. */
|
||||
@Input()
|
||||
id: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this name. */
|
||||
@Input()
|
||||
name: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this process definition ID. */
|
||||
@Input()
|
||||
processDefinitionId: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this process definition key. */
|
||||
@Input()
|
||||
processDefinitionKey: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this serviceFullName value. */
|
||||
@Input()
|
||||
serviceFullName: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this serviceName value. */
|
||||
@Input()
|
||||
serviceName: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this serviceType value. */
|
||||
@Input()
|
||||
serviceType: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this serviceVersion value. */
|
||||
@Input()
|
||||
serviceVersion: string = '';
|
||||
|
||||
/** Filter the processes to display only the ones with this status. */
|
||||
@Input()
|
||||
status: string = '';
|
||||
|
||||
/** Filter the tasks to display only the ones with this businessKey value. */
|
||||
@Input()
|
||||
businessKey: string = '';
|
||||
|
||||
/** Toggles default selection of the first row */
|
||||
@Input()
|
||||
selectFirstRow: boolean = true;
|
||||
|
||||
/**
|
||||
* Define which task id should be selected after reloading.
|
||||
* If the task id doesn't exist or nothing is passed then the first
|
||||
* task will be selected.
|
||||
*/
|
||||
@Input()
|
||||
landingTaskId: string;
|
||||
|
||||
/**
|
||||
* Row selection mode. Can be "none", "single" or "multiple".
|
||||
* For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier
|
||||
* key to toggle selection for multiple rows.
|
||||
*/
|
||||
@Input()
|
||||
selectionMode: string = 'single'; // none|single|multiple
|
||||
|
||||
/** Toggles multiple row selection, renders checkboxes at the beginning of each row */
|
||||
/** Toggles multiple row selection and renders checkboxes at the beginning of each row */
|
||||
@Input()
|
||||
multiselect: boolean = false;
|
||||
|
||||
/**
|
||||
* Array of objects specifying the sort order and direction for the
|
||||
* list. The sort parameters are for BE sorting.
|
||||
*/
|
||||
@Input()
|
||||
sorting: ProcessListCloudSortingModel[];
|
||||
|
||||
/** Emitted when a row in the process list is clicked. */
|
||||
@Output()
|
||||
rowClick: EventEmitter<string> = new EventEmitter<string>();
|
||||
|
||||
/** Emitted when rows are selected/unselected. */
|
||||
@Output()
|
||||
rowsSelected: EventEmitter<any[]> = new EventEmitter<any[]>();
|
||||
|
||||
/** Emitted when an error occurs while loading the list of process instances from the server. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
/** Emitted when the list of process instances has been loaded successfully from the server. */
|
||||
@Output()
|
||||
success: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
Reference in New Issue
Block a user