Interface IdentitySelectProperties

Properties for SVICustomElement.IdentitySelect.

Example: HTML Example #1 - Provide a custom set of User/Group identities to display in dialog

<svi-identity-select
  [model]="selectedIdentities"
  [identities]="myIdentitiesList"
  [selectionMode]="SelectionMode.UsersAndGroups"
  [selfSelectBtn]="true"
  [filter]="{ byGroups: ['alpha', 'bravo'] }"
  (modelChanged)="onSelectionChange($event)"
></svi-identity-select>

Example: HTML Example #2 - Retrieve a list of users from the identities service in dialog

<svi-identity-select
  [model]="selectedIdentities"
  [ariaLabel]="'Select Users'"
  [selectionMode]="SelectionMode.Users"
  [selfSelectBtn]="true"
  (modelChanged)="onSelectionChange($event)"
></svi-identity-select>

Example: Create element via document.createElement:

const identitySelect = document.createElement(SVICustomElement.IdentitySelect);
identitySelect.identities = this.myIdentitiesList;
identitySelect.ariaLabel = "My label";
interface IdentitySelectProperties {
    ariaLabel?: string;
    autocomplete?: string;
    filter?: IIdentitySelectFilterOptions;
    id?: string;
    identities?: IIdentityOption[];
    inlineSelectCurrentUserBtn?: boolean;
    inputBlur?: ((event: FocusEvent) => void);
    inputFocus?: ((event: FocusEvent) => void);
    isDisabled?: boolean;
    limitSelectionToMembersOf?: string | ILimitSelectionToConfig;
    model?: any;
    modelChanged?: ((modelValue: any) => void);
    placeholder?: string;
    readOnly?: boolean;
    selectionMode?: SelectionMode;
    selfSelectBtn?: boolean;
    title?: string;
}

Hierarchy (view full)

Properties

ariaLabel? autocomplete? filter? id? identities? inlineSelectCurrentUserBtn? inputBlur? inputFocus? isDisabled? limitSelectionToMembersOf? model? modelChanged? placeholder? readOnly? selectionMode? selfSelectBtn? title?

Properties

OptionalariaLabel

ariaLabel?: string

ARIA label for identifying the list.

Optionalautocomplete

autocomplete?: string

Optionalfilter

filter?: IIdentitySelectFilterOptions

The filtering options used when the available identities are retrieved from the identities microservice. (default: false)

Optionalid

id?: string

Optionalidentities

identities?: IIdentityOption[]

The available users and groups to select from. If not provided, the identities are retrieved from the identities microservice.

OptionalinlineSelectCurrentUserBtn

inlineSelectCurrentUserBtn?: boolean

Determines if the current user button is displayed above or to the left/right of the identity-select control. (default: false)

OptionalinputBlur

inputBlur?: ((event: FocusEvent) => void)

OptionalinputFocus

inputFocus?: ((event: FocusEvent) => void)

OptionalisDisabled

isDisabled?: boolean

OptionallimitSelectionToMembersOf

limitSelectionToMembersOf?: string | ILimitSelectionToConfig

Only members of the given group will be valid and selectable. If inclusive if true, the group itself is treated as a valid selection.

Accepts the group id as a string, or as part of configuration object.

Optionalmodel

model?: any

OptionalmodelChanged

modelChanged?: ((modelValue: any) => void)

Optionalplaceholder

placeholder?: string

OptionalreadOnly

readOnly?: boolean

OptionalselectionMode

selectionMode?: SelectionMode

Does the input allow the selection of only a user, users, a group, groups, or both? (default: SelectionMode.UsersAndGroups)

OptionalselfSelectBtn

selfSelectBtn?: boolean

Determines whether the select current user button is displayed. (default: false)

Optionaltitle

title?: string

Optional title that can be used to override the default dialog title.

Settings

Member Visibility

On This Page

Properties