mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

siva kumar eb2811fdd0 [ADF-4738] [Process -Cloud] Move GroupCloudService to adf-core (#4928 )

* [ADF-4738] [Process -Cloud] Move GroupCloudService to adf-core lib.

* * Changed GroupModel to IdentityGroupModel
* Updated unit tests the recent changes.

* * Added documentation to the identityGroupService
* Updated GroupInitial and GroupCoudcomponent doc.

* * Created groupCount model. * Updated unit test to the recent changes

* * After rebase updated doc

* * Fixed comments.

2019-08-12 16:27:30 +01:00

2.5 KiB

Raw Blame History

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Group Cloud component	v3.0.0	Experimental	2019-03-20

Group Cloud component

Searches Groups.

Basic Usage

<adf-cloud-group
    [appName]="'simple-app'"
    [mode]="'multiple'">
</adf-cloud-group>

Class members

Properties

Name	Type	Default value	Description
appName	`string`		Name of the application. If specified this shows the users who have access to the app.
mode	`string`		User selection mode (single/multiple).
preSelectGroups	`IdentityGroupModel[]`	[]	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.
roles	`string[]`	[]	Role names of the groups to be listed.
searchGroupsControl	`FormControl`	new FormControl()	FormControl to search the group
title	`string`		Title of the field

Events

Name	Type	Description
removeGroup	`EventEmitter<IdentityGroupModel>`	Emitted when a group is removed.
selectGroup	`EventEmitter<IdentityGroupModel>`	Emitted when a group is selected.

Details

Selection Mode

You can specify either single selection or multiple selection (single is the default):

Single selection

<adf-cloud-group></adf-cloud-group>

Multiple selection

<adf-cloud-group
    [mode]="'multiple'">
</adf-cloud-group>

Pre-selection

Usage example:

import { ObjectDataTableAdapter }  from '@alfresco/adf-core';

@Component({...})
export class MyComponent {
    groups: any;

    constructor() {
        this.groups =
            [
                {id: 1, name: 'Group 1'},
                {id: 2, name: 'Group 2'}
            ];
    }
}

<adf-cloud-group
    [mode]="'multiple'"
    [preSelectGroups]="groups">
</adf-cloud-group>

2.5 KiB Raw Blame History