Interface IdentitySelectActionProperties

Properties for SVICustomElement.IdentitySelectAction.

Example: HTML Example #1 - Select Users and Groups

<svi-identity-select-action
  [model]="selectedIdentities"
  [title]="'Multiple Users and Groups from Button'"
  [hideLabel]="true"
  (selectionDialogClose)="onDialogClose($event)"
  (modelChanged)="onSelectionChange($event)"
></svi-identity-select-action>

Example: HTML Example #1 - Select Users Only

<svi-identity-select-action
  [model]="selectedIdentities"
  [title]="'Multiple Users from Button'"
  [hideLabel]="true"
  [selectionMode]="selectionMode.Users"
  (selectionDialogClose)="onDialogClose($event)"
  (modelChanged)="onSelectionChange($event)"
></svi-identity-select-action>

Example: Create element via document.createElement:

const identityAvatar = document.createElement(SVICustomElement.IdentitySelectAction);
identitySelect.title = this.title;
identitySelect.actionMode = this.actionMode;
interface IdentitySelectActionProperties {
    actionMode?: ActionMode;
    disabled?: boolean;
    filter?: IIdentitySelectFilterOptions;
    hideLabel?: boolean;
    iconClass?: string;
    identities?: IIdentityOption[];
    label?: string;
    limitSelectionToMembersOf?: string | ILimitSelectionToConfig;
    okButtonLabel?: string;
    selectedIdentities?: IIdentityOption[];
    selectionDialogClose?: ((event: CustomEvent<any>) => void);
    selectionMode?: SelectionMode;
    tabIndex?: string;
    title?: string;
}

Properties

actionMode? disabled? filter? hideLabel? iconClass? identities? label? limitSelectionToMembersOf? okButtonLabel? selectedIdentities? selectionDialogClose? selectionMode? tabIndex? title?

Properties

OptionalactionMode

actionMode?: ActionMode

Determines if the action is rendered as a Button or MenuItem (default: ActionMode.Button).

Optionaldisabled

disabled?: boolean

Disables the component's controls. (default: false)

Optionalfilter

filter?: IIdentitySelectFilterOptions

The filtering options used when the available identities are retrieved from the identities microservice.

OptionalhideLabel

hideLabel?: boolean

Defines if the label will be hidden. (default: false).

OptionaliconClass

iconClass?: string

Optional icon class that can be used to override the default button icon.

Optionalidentities

identities?: IIdentityOption[]

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

Optionallabel

label?: string

Optional label that can be used to override the default button label.

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.

OptionalokButtonLabel

okButtonLabel?: string

Label for the identity select dialog "ok" button. (default: "ok")

OptionalselectedIdentities

selectedIdentities?: IIdentityOption[]

Pre-select Identities.

OptionalselectionDialogClose

selectionDialogClose?: ((event: CustomEvent<any>) => void)

Emits the selected identities when the dialog's ok button is clicked.

OptionalselectionMode

selectionMode?: SelectionMode

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

OptionaltabIndex

tabIndex?: string

The tabIndex for the button (default: TabIndex.Tabbable).

Optionaltitle

title?: string

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

Settings

Member Visibility

On This Page

Properties