Interface IComboSlot

Represents a combo slot for a combo field.

IComboSlot

interface IComboSlot {
    description?: string;
    dirty: boolean;
    disabled?: boolean;
    fieldReadonly: boolean;
    freeSolo?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    incorrect: null | string;
    invalid: null | string;
    itemList?:
        | string[]
        | (data: any, payload: any) => string[]
        | (data: any, payload: any) => Promise<string[]>;
    labelShrink?: boolean;
    loading: boolean;
    noDeselect?: boolean;
    onChange: (v: any, config?: { skipReadonly?: boolean }) => void;
    outlined?: boolean;
    placeholder?: string;
    readonly: boolean;
    title?: string;
    tr?:
        | (s: string, data: any, payload: any) => string
        | (s: string, data: any, payload: any) => Promise<string>;
    validation?: IValidation;
    value: any;
    virtualListBox?: boolean;
    watchItemList?: boolean;
    withContextMenu: undefined | true;
}

Hierarchy (View Summary)

Properties

description? dirty disabled? fieldReadonly freeSolo? groupRef? incorrect invalid itemList? labelShrink? loading noDeselect? onChange outlined? placeholder? readonly title? tr? validation? value virtualListBox? watchItemList? withContextMenu

Properties

Optionaldescription

description?: string

Retrieves the "description" property

dirty

dirty: boolean

Optionaldisabled

disabled?: boolean

Represents the "disabled" property of a field.

fieldReadonly

fieldReadonly: boolean

OptionalfreeSolo

freeSolo?: boolean

Represents the freeSolo property of an object.

OptionalgroupRef

groupRef?: (element?: null | HTMLDivElement) => void

This variable represents a reference to a group within a field's data payload. It is an optional property and is of type PickProp<IField<Data, Payload>, 'groupRef'>.

incorrect

incorrect: null | string

invalid

invalid: null | string

OptionalitemList

itemList?:
    | string[]
    | (data: any, payload: any) => string[]
    | (data: any, payload: any) => Promise<string[]>

Represents a list of items from a specific field's data payload.

OptionallabelShrink

labelShrink?: boolean

Represents the property labelShrink which is an optional pick property of type PickProp<IField<Data>, "labelShrink">.

loading

loading: boolean

OptionalnoDeselect

noDeselect?: boolean

Specifies whether the field should allow deselection.

Template: Data

The data type of the field.

Template: Payload

The payload type of the field.

Param: noDeselect

The value of the noDeselect property.

Returns

  • This function does not return any value.

onChange

onChange: (v: any, config?: { skipReadonly?: boolean }) => void

Optionaloutlined

outlined?: boolean

Type outlined defenition

Template: T

The type of the input object.

Template: K

The name of the property to pick from the input object.

Optionalplaceholder

placeholder?: string

Represents the placeholder property of a field.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

readonly

readonly: boolean

Optionaltitle

title?: string

Retrieves the "title" property for a field

Optionaltr

tr?:
    | (s: string, data: any, payload: any) => string
    | (s: string, data: any, payload: any) => Promise<string>

Represents an optional property "tr" of type PickProp<IField<Data, Payload>, "tr">.

Optionalvalidation

validation?: IValidation

Validation factory config

Template: IField

Type representing the field object.

Template: Data

Type representing the data object.

Template: Payload

Type representing the payload object.

Returns

The value of the "validation" property.

value

value: any

OptionalvirtualListBox

virtualListBox?: boolean

Represents a virtual list box configuration.

OptionalwatchItemList

watchItemList?: boolean

Represents the watch item list for a specific field.

withContextMenu

withContextMenu: undefined | true

Settings

Member Visibility

On This Page

Properties