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

[ADF-3745] Reviewed new Group cloud component docs (#4160)

Browse Source 
* [ADF-3745] Reviewed group cloud docs

* [ADF-3745] Fixed incorrect type link
This commit is contained in:
Andy Stark 2019-01-15 12:12:24 +00:00 committed by Eugenio Romano
parent e3648dea5f
commit 0d8beb195a
2 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/process-services-cloud/group-cloud.component.md
View File

@ -1,11 +1,11 @@
--- ---
Title: Group Cloud component Title: Group Cloud component
Added: v3.0.0 Added: v3.0.0
Status: Active Status: Experimental
Last reviewed: 2018-20-11 Last reviewed: 2019-01-15
--- ---
# [Group Cloud component](../../lib/process-services-cloud/src/lib/group-cloud/components/group-cloud.component.ts "Defined in group-cloud.component.ts") # [Group Cloud component](../../process-services-cloud/src/lib/group/components/group-cloud.component.ts "Defined in group-cloud.component.ts")
Searches Groups. Searches Groups.
@ -26,26 +26,25 @@ Searches Groups.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| applicationName | `string` | | Name of the application. If specified, shows the groups who have access to the app. | | applicationName | `string` | | Name of the application. If specified this shows the users who have access to the app. |
| mode | `string` | 'single' | Mode of the user selection (single/multiple). | | mode | `string` | | User selection mode (single/multiple). |
| preSelectGroups | `GroupModel[]` | Array of groups to be pre-selected. Pre-select all groups in `multiple` mode and only the first group of the array in `single` mode. | | preSelectGroups | [`GroupModel`](../../process-services-cloud/src/lib/group/models/group.model.ts)`[]` | \[] | Array of users to be pre-selected. This pre-selects all users in multi selection mode and only the first user of the array in single selection mode. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../lib/process-services-cloud/src/lib/group-cloud/models/group.model.ts)`>` | Emitted when a group selected. | | removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is removed. |
| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../lib/process-services-cloud/src/lib/group-cloud/models/group.model.ts)`>` | Emitted when selected group is removed in `multiple` mode. | | selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is selected. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` |
## Details ## Details
### Selection Mode ### Selection Mode
You can provide selection mode singe(default)/multiple You can specify either single selection or multiple selection (single
is the default):
## Single select #### Single selection
```html ```html
<adf-cloud-group></adf-cloud-group> <adf-cloud-group></adf-cloud-group>
@ -53,7 +52,7 @@ You can provide selection mode singe(default)/multiple
![adf-cloud-group](../docassets/images/group-cloud.component-single.png) ![adf-cloud-group](../docassets/images/group-cloud.component-single.png)
## Multiple select #### Multiple selection
```html ```html
<adf-cloud-group <adf-cloud-group
@ -63,7 +62,7 @@ You can provide selection mode singe(default)/multiple
![adf-cloud-group](../docassets/images/group-cloud.component-multiple-mode.png) ![adf-cloud-group](../docassets/images/group-cloud.component-multiple-mode.png)
## Pre-select ### Pre-selection
Usage example: Usage example:

6
lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts
View File

@ -46,15 +46,15 @@ export class GroupCloudComponent implements OnInit {
@ViewChild('groupInput') groupInput: ElementRef<HTMLInputElement>; @ViewChild('groupInput') groupInput: ElementRef<HTMLInputElement>;
/** Name of the application. If specified, shows the users who have access to the app. */ /** Name of the application. If specified this shows the users who have access to the app. */
@Input() @Input()
applicationName: string; applicationName: string;
/** Mode of the user selection (single/multiple). */ /** User selection mode (single/multiple). */
@Input() @Input()
mode: string = GroupCloudComponent.MODE_SINGLE; mode: string = GroupCloudComponent.MODE_SINGLE;
/** Array of users to be pre-selected. Pre-select all users in multi selection mode and only the first user of the array in single selection mode. */ /** Array of users to be pre-selected. This pre-selects all users in multi selection mode and only the first user of the array in single selection mode. */
@Input() @Input()
preSelectGroups: GroupModel[] = []; preSelectGroups: GroupModel[] = [];