Function CompleteField

Parameters

• props: ICompleteFieldProps<any, any> & ICompleteFieldPrivate<any>

  The props for the CompleteField component.

  Interface for specifying the props of a complete field.

  • OptionalautoFocus?: boolean

    Specifies whether the field should be automatically focused.

  • Optionaldescription?: string

    Retrieves the "description" property from a given object and its nested properties if available.

    Template: T

    The type of the object to pick the "description" property from.

    Template: K

    The keys of the properties in T.

    Param: obj

    The object to pick the "description" property from.

    Returns

    • The picked object with "description" property.

  • Optionaldisabled?: boolean

    Represents the "disabled" property of a field.

    Template: Data

    The type of data associated with the field.

    Template: Payload

    The type of payload for the field's actions.

  • OptionalgroupRef?: (element?: null | HTMLDivElement) => void

    Represents a reference to a group within a field.

  • OptionalinputAutocomplete?: "new-password" | "on" | "off" | "false"

    Represents the optional prop "inputAutocomplete" for a field.

    Param: inputAutocomplete

    The value of the "inputAutocomplete" prop.

    Returns

  • OptionalinputFormatter?: (input: string) => string

    Represents the input formatter property of a field within a specific data type.

  • OptionalinputFormatterAllowed?: RegExp | (char: string, idx: number) => boolean

    Determines whether input formatting is allowed for a given field.

  • OptionalinputFormatterReplace?: (char: string) => null | string

    Replaces the input formatter of a field with a new one.

  • OptionalinputFormatterSymbol?: string

    Represents the input formatter symbol for a specific field.

  • OptionalinputFormatterTemplate?: string

    Represents a template for formatting input data.

  • OptionalinputMode?: "search" | "text" | "email" | "tel" | "url" | "none" | "numeric" | "decimal"

    Represents the input mode of a field in the data object payload.

  • OptionalinputPattern?: string

    Represents the input pattern of a field.

  • OptionalinputRef?: (element?: null | HTMLInputElement) => void

    Represents the input reference of a field.

  • OptionalinputType?:
        | "number"
        | "color"
        | "search"
        | "text"
        | "date"
        | "email"
        | "month"
        | "password"
        | "tel"
        | "time"
        | "url"
        | "week"

    Represents the input type of a field.

    Template: Data

    The type of data associated with the field.

    Template: Payload

    The type of payload associated with the field.

  • OptionalkeepRaw?: boolean

    Represents the value of the keepRaw property, which indicates whether to keep the raw data in a field.

    Template: Data

    The data type of the field.

    Template: Payload

    The payload type of the field.

  • OptionallabelShrink?: boolean

    Reduces the size of the label for a given field.

    Param: labelShrink

    The label shrink configuration for a field.

    Returns

  • Optionaloutlined?: boolean

    Returns the value of the outlined property from the provided object.

    Template: T

    The type of the object.

    Template: K

    The keyof T representing the property to pick.

    Param: obj

    The object from which to pick the property.

    Param: field

    The key representing the property to pick.

    Returns

    • The value of the picked property.

  • Optionalplaceholder?: string

    Retrieves the placeholder property of a given field.

    Template: Data

    The type of data associated with the field.

    Template: Payload

    The type of payload associated with the field.

    Template: Field

    The type of field.

    Param: field

    The field to pick the placeholder property from.

    Returns

    • The placeholder property of the given field, if present. Otherwise, undefined.

  • Optionalreadonly?: boolean

    Retrieves the "readonly" property from the provided field object.

    Param: field

    The field object.

    Returns

    • The value of the "readonly" property.

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

    Represents the "tip" property of an object.

    Template: T

    The type of the object.

    Template: K

    The key of the property to pick.

  • OptionaltipSelect?: (
        value: string,
        data: Data,
        payload: Payload,
        onChange: (data: Data) => void,
    ) => void

    Represents a variable that holds the value of the "tipSelect" property.

  • Optionaltitle?: string

    Type definition for the "title" property picked from the "IField" object type, where "IField" is a generic object with properties "Data" and "Payload". The resulting type is determined by the "PickProp" utility, which selects the specific property from the provided object type.

    Template: IField

    The generic object type with properties "Data" and "Payload".

    Template: Data

    The data type of the "IField" object.

    Template: Payload

    The payload type of the "IField" object.

    Template: Key

    The specific property key to pick from the "IField" object.

    Returns

    The type of the picked property.

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

  Represents a private interface for a complete field.

  • dirty: boolean

  • disabled: boolean

  • fieldReadonly: boolean

  • incorrect: null | string

  • invalid: null | string

  • loading: boolean

  • name: string

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

  • readonly: boolean

  • value: any

  • withContextMenu: undefined | true