Interface IChooseFieldProps<Data, Payload>

Props for the IChooseField component.

interface IChooseFieldProps<Data = IAnything, Payload = IAnything> {
    choose?: (
        data: Data,
        payload: Payload,
    ) => null | string | string[] | Promise<null | string | string[]>;
    description?: string;
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    inputRef?: (element?: null | HTMLInputElement) => void;
    labelShrink?: 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;
}

Type Parameters

  • Data = IAnything

    The data type of the field.

  • Payload = IAnything

    The payload type of the field.

Properties

choose? description? disabled? groupRef? inputRef? labelShrink? outlined? placeholder? readonly? title? tr? validation?

Properties

Optionalchoose

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

Type definition for the 'choose' property of IField.

Optionaldescription

description?: string

Retrieves the "description" property from the given object.

Template: IField

Type representing the field object.

Template: Data

Type representing the data object.

Template: Payload

Type representing the payload object.

Param: obj

The object from which to pick the "description" property.

Returns

The value of the "description" property.

Optionaldisabled

disabled?: boolean

Type definition for the "disabled" property of a field.

This type is used to define the "disabled" property of a field from an object type "Data" and a type "Payload" using the PickProp utility type.

Template: Data

The type representing the object structure.

Template: Payload

The type representing the additional properties of the field.

OptionalgroupRef

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

A reference to the group that the field belongs to.

OptionalinputRef

inputRef?: (element?: null | HTMLInputElement) => void

This variable represents the inputRef property of type PickProp<IField<Data, Payload>, 'inputRef'>. It is an optional property, which means it may be undefined.

OptionallabelShrink

labelShrink?: boolean

Represents the configuration for label shrinking in a field.

Optionaloutlined

outlined?: boolean

Type definition for the PickProp function.

Template: T

The type of the object to pick properties from.

Template: K

The keys to pick from the object.

Optionalplaceholder

placeholder?: string

Type definition for a generic placeholder value.

Optionalreadonly

readonly?: boolean

A variable that represents the readonly property of a field.

Optionaltitle

title?: string

Type definition for the title property when using PickProp utility.

Template: T

The type of the object from which to pick the property.

Template: Prop

The name of the property to pick.

Param: obj

The object from which to pick the property.

Param: prop

The name of the property to pick.

Returns

  • The picked property value.

Optionaltr

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

Represents a possible translation for a field in a form.

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.

Settings

Member Visibility

On This Page

Properties