File

projects/angular/components/ui-suggest/src/models/suggestValue.ts

Description

UiSuggest item schema.

Extends

VirtualScrollItem

Index

Properties

Properties

disabled
disabled: boolean
Type : boolean
Optional

Flag that marks if item is disabled.

expandable
expandable: boolean
Type : boolean
Optional

Flag that marks if item is expandable. Will be ignored if ui-suggest doesn't have drillDown and searchable. On selection will trigger a new searchSource call, value will NOT updated yet. The string input will be applied as ${item.text}:

icon
icon: literal type
Type : literal type
Optional

Optional icon that will be displayed to the left of the item.

id
id: number | string
Type : number | string

Unique identifier associated to the entry.

text
text: string
Type : string

Text associated to the entry.

import {
    VirtualScrollItem,
    VirtualScrollItemStatus,
} from '@uipath/angular/directives/ui-virtual-scroll-range-loader';

/**
 * UiSuggest item schema.
 *
 * @export
 */
export interface ISuggestValue extends VirtualScrollItem {
    /**
     * Unique identifier associated to the entry.
     *
     */
    id: number | string;
    /**
     * Text associated to the entry.
     *
     */
    text: string;
    /**
     * Marks the current item state
     *
     * @internal
     * @ignore
     */
    loading?: VirtualScrollItemStatus;
    /**
     * Flag that marks custom items.
     *
     * @internal
     * @ignore
     */
    isCustom?: boolean;
    /**
     * Flag that marks if item is expandable.
     * Will be ignored if ui-suggest doesn't have drillDown and searchable.
     * On selection will trigger a new searchSource call, value will NOT updated yet.
     * The string input will be applied as `${item.text}:`
     */
    expandable?: boolean;
    /**
     * Flag that marks if item is disabled.
     */
     disabled?: boolean;
    /**
     * Optional icon that will be displayed to the left of the item.
     *
     */
    icon?: {
        iconOnly?: boolean;
        svgIcon?: string;
        matIcon?: string;
    };
}

results matching ""

    No results matching ""