Function ItemsField

Parameters

• props: IItemsFieldProps<any, any> & IItemsFieldPrivate<any>

  The properties for the ItemsField component.

  Props for the IItemsField component.

  • Optionaldescription?: 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?: boolean

    Represents the "disabled" property of a field.

  • OptionalfreeSolo?: 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?: (element?: null | HTMLDivElement) => void

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

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

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

  • OptionallabelShrink?: 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?: 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?: 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?: 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?: boolean

    Represents an optional readonly flag of a field.

  • Optionaltitle?: 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?:
        | (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?: 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?: boolean

    Represents the configuration for a virtual list box field in a form.

  • OptionalwatchItemList?: boolean

    Represents a variable watchItemList.

  Represents a private interface for an items field.

  IItemsFieldPrivate

  • dirty: boolean

  • fieldReadonly: boolean

  • incorrect: null | string

  • invalid: null | string

  • loading: boolean

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

  • value: any

  • withContextMenu: undefined | true