Interface IComboFieldProps<Data, Payload>

Represents the properties for the ComboField component.

interface IComboFieldProps<Data = IAnything, Payload = IAnything> {
    description?: string;
    disabled?: boolean;
    freeSolo?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    itemList?:
        | string[]
        | (data: Data, payload: Payload) => string[]
        | (data: Data, payload: Payload) => Promise<string[]>;
    labelShrink?: boolean;
    noDeselect?: boolean;
    outlined?: boolean;
    placeholder?: string;
    readonly?: boolean;
    title?: string;
    tr?:
        | (s: string, data: Data, payload: Payload) => string
        | (s: string, data: Data, payload: Payload) => Promise<string>;
    validation?: IValidation;
    virtualListBox?: boolean;
    watchItemList?: boolean;
}

Type Parameters

  • Data = IAnything

    The type of data associated with the field.

  • Payload = IAnything

    The type of payload associated with the field.

Properties

description? disabled? freeSolo? groupRef? itemList? labelShrink? noDeselect? outlined? placeholder? readonly? title? tr? validation? virtualListBox? watchItemList?

Properties

Optionaldescription

description?: string

Retrieves the "description" property

Optionaldisabled

disabled?: boolean

Represents the "disabled" property of a field.

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'>.

OptionalitemList

itemList?:
    | string[]
    | (data: Data, payload: Payload) => string[]
    | (data: Data, payload: Payload) => 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">.

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.

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.

Optionalreadonly

readonly?: boolean

Retrieves the "readonly" property from a given object of type IField<Data, Payload>.

Param: field

The object from which to retrieve the "readonly" property.

Returns

The value of the "readonly" property.

Optionaltitle

title?: string

Retrieves the "title" property for a field

Optionaltr

tr?:
    | (s: string, data: Data, payload: Payload) => string
    | (s: string, data: Data, payload: Payload) => 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.

OptionalvirtualListBox

virtualListBox?: boolean

Represents a virtual list box configuration.

OptionalwatchItemList

watchItemList?: boolean

Represents the watch item list for a specific field.

Settings

Member Visibility

On This Page

Properties