Interface IItemsFieldProps<Data, Payload>

Props for the IItemsField component.

interface IItemsFieldProps<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 for the field.

  • Payload = IAnything

    The type of payload for the field.

Hierarchy (View Summary)

Properties

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

Properties

Optionaldescription

description?: string

Returns the "description" property of the given object if it exists, otherwise returns undefined.

Template: T

The type of the object to pick the property from.

Template: K

The key of the property to pick.

Param: obj

The object to pick the property from.

Param: key

The key of the property to pick.

Returns

  • The value of the "description" property if it exists, otherwise undefined.

Optionaldisabled

disabled?: boolean

Represents the "disabled" property of a field.

OptionalfreeSolo

freeSolo?: boolean

Represents the freeSolo property of a field object.

Description

This property determines if the field supports selecting values that are not contained in the predefined options list.

OptionalgroupRef

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

Retrieves the value of the 'groupRef' property from the given object 'fieldData'.

Type declaration

    • (element?: null | HTMLDivElement): void

    • Parameters

      • Optionalelement: null | HTMLDivElement

      Returns void

      • The value of the 'groupRef' property from 'fieldData', or undefined if it doesn't exist.

OptionalitemList

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

Represents the itemList property of a field in the Data object.

OptionallabelShrink

labelShrink?: boolean

Represents the optional "labelShrink" property of an object that implements the IField<Data> interface. The "labelShrink" property is of type PickProp<IField<Data>, "labelShrink">, which picks the "labelShrink" property from the IField<Data> interface.

OptionalnoDeselect

noDeselect?: boolean

Represents a configuration option for disabling deselect functionality.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

Optionaloutlined

outlined?: boolean

Picks the specified property "outlined" from the given object type "IField<Data, Payload>".

Template: Data

The type of data for the field.

Template: Payload

The type of payload for the field.

Template: T

The resulting type after picking the property.

Param: field

The object from which to pick the property.

Returns

  • The value of the "outlined" property.

Optionalplaceholder

placeholder?: string

Type definition for the placeholder property.

Template: T

The type of the field.

Template: K

The type of the key to pick from the field.

Param: field

The field object.

Param: key

The key representing the property to pick from the field.

Returns

The picked placeholder property from the field.

Optionalreadonly

readonly?: boolean

Represents an optional readonly flag of a field.

Optionaltitle

title?: string

Type definition for the "title" property of an object.

Suppose we have an object of type "IField<Data, Payload>". This type represents a field in a form, where "Data" is the type of the form data and "Payload" is the type of data that should be submitted when the form is submitted.

The "PickProp" utility type is used to extract the "title" property from the "IField<Data, Payload>" type. This variable represents the extracted type.

Template: Data

The type of the form data.

Template: Payload

The type of the data to be submitted.

Optionaltr

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

Represents the "tr" property of a field in the given data and payload.

Template: Data

The type of data.

Template: Payload

The type of payload.

Type Param: IField

The type of field.

Type Param: PickProp

The type for picking properties.

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 the configuration for a virtual list box field in a form.

OptionalwatchItemList

watchItemList?: boolean

Represents a variable watchItemList.

Settings

Member Visibility

On This Page

Properties