Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 4.18 KB

people-cloud.component.md

File metadata and controls

83 lines (64 loc) · 4.18 KB
Raw

Title: People Cloud Component Added: v3.0.0 Status: Experimental

Last reviewed: 2019-03-20

People Cloud Component

Allows one or more users to be selected (with auto-suggestion) based on the input parameters.

Basic Usage

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

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.
excludedUsers IdentityUserModel[] [] Array of users to be excluded. Mandatory properties are: id, email, username
groupsRestriction string[] [] Array of groups to restrict user searches. Mandatory property is group name
mode ComponentSelectionMode "single" User selection mode (single/multiple).
preSelectUsers IdentityUserModel[] [] Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username
readOnly boolean false Show the info in readonly mode
required boolean false Mark this field as required
roles string[] Role names of the users to be listed.
searchUserCtrl FormControl<any> FormControl to search the user
title string Placeholder translation key
userChipsCtrl UntypedFormControl FormControl to list of users
validate boolean false This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done.

Events

Name Type Description
changedUsers EventEmitter<IdentityUserModel[]> Emitted when a user selection change.
removeUser EventEmitter<IdentityUserModel> Emitted when a selected user is removed in multi selection mode.
selectUser EventEmitter<IdentityUserModel> Emitted when a user is selected.
warning EventEmitter<any> Emitted when an warning occurs.

Details

Read-only

You can use readonly property to set the component in readonly mode. Readonly mode will disable any interaction with the component.

<adf-cloud-people
    [appName]="'simple-app'"
    [mode]="'multiple'"
    [preSelectUsers]="preSelectUsers"
    [readOnly]="true">
</adf-cloud-people>

If you want to manage each user seperately you can set their readonly property at your preference. You need to have component's readonly property set to false. Component's readonly mode overwrites users level.

const preSelectUsers = [
        { "id": "1", "username": "username1", "firstName": "user 1", "readonly": true },
        { "id": "2", "username": "username2", "firstName": "user 2", "readonly": false },
        { "id": "3", "username": "username3", "firstName": "user 3", "readonly": true }
    ];
<adf-cloud-people
    [mode]="'multiple'"
    [preSelectUsers]="preSelectUsers">
</adf-cloud-people>

from above preSelectUsers, username2 is removable from the preSelectUsers whereas username1, username3 are readonly you can not remove them.