ComboField component.

  • Parameters

    • props: IComboFieldProps<any, any> & IComboFieldPrivate<any>

      The props object.

      Represents the properties for the ComboField component.

      • Optionaldescription?: string

        Retrieves the "description" property

      • Optionaldisabled?: boolean

        Represents the "disabled" property of a field.

      • OptionalfreeSolo?: boolean

        Represents the freeSolo property of an object.

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

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

      • OptionalnoDeselect?: boolean

        Specifies whether the field should allow deselection.

        The data type of the field.

        The payload type of the field.

        The value of the noDeselect property.

        • This function does not return any value.
      • Optionaloutlined?: boolean

        Type outlined defenition

        The type of the input object.

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

      • Optionalplaceholder?: string

        Represents the placeholder property of a field.

        The type of data associated with the field.

        The type of payload associated with the field.

      • Optionalreadonly?: boolean

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

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

        The value of the "readonly" property.

      • Optionaltitle?: string

        Retrieves the "title" property for a field

      • Optionaltr?:
            | (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?: IValidation

        Validation factory config

        Type representing the field object.

        Type representing the data object.

        Type representing the payload object.

        The value of the "validation" property.

      • OptionalvirtualListBox?: boolean

        Represents a virtual list box configuration.

      • OptionalwatchItemList?: boolean

        Represents the watch item list for a specific field.

      Represents the private interface for the ComboField class.

      • dirty: boolean
      • fieldReadonly: boolean
      • incorrect: null | string
      • invalid: null | string
      • loading: boolean
      • onChange: (v: any, config?: { skipReadonly?: boolean }) => void
      • readonly: boolean
      • value: any
      • withContextMenu: undefined | true

    Returns Element

    The ComboField component.

Properties

Properties

displayName: string