Interface IYesNoFieldProps<Data, Payload>

Interface representing the props for the YesNoField component.

interface IYesNoFieldProps<Data = IAnything, Payload = IAnything> {
    description?: string;
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    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;
}

Type Parameters

Properties

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

Properties

Optionaldescription

description?: string

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

Template: Data

The type of the data associated with the field.

Template: Payload

The type of the payload associated with the field.

Param: field

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

Returns

  • The picked "description" property.

Optionaldisabled

disabled?: boolean

Represents the disabled property of a field object.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

OptionalgroupRef

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

Represents the groupRef property of an object.

OptionallabelShrink

labelShrink?: boolean

Represents the optional property to shrink the label of a field.

OptionalnoDeselect

noDeselect?: boolean

Represents an optional property "noDeselect" of a PickProp object.

Template: T

The type of the field.

Template: K

The key of the property to be picked.

Template: P

The type of the value of the picked property.

Optionaloutlined

outlined?: boolean

Type declaration for the outlined property of the PickProp utility. This utility allows you to pick a specific property from a given type and create a new type with only that property.

Template: T

The original type from which we want to pick a property.

Template: K

A string literal representing the property we want to pick from the original type.

Optionalplaceholder

placeholder?: string

Retrieves the "placeholder" property of the provided PickProp type, which is a property value of type string.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

Template: T

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

Template: K

The type of the property to be picked.

Param: obj

The input object from which to pick the property.

Param: prop

The property to be picked from the input object.

Returns

The value of the "placeholder" property of the provided PickProp type.

Optionalreadonly

readonly?: boolean

Represents the 'readonly' property of an object, extracted using the 'PickProp' utility type.

Template: Data

The type of data contained in the 'IField' object.

Template: Payload

The type of payload contained in the 'IField' object.

Param: readonly

The value of the 'readonly' property.

Returns

  • This function does not return a value.

Optionaltitle

title?: string

Returns the value of the "title" property from an object of type IField<Data, Payload>.

Template: Data

The type of the data object.

Template: Payload

The type of the payload object.

Template: T

The type of the object containing the "title" property.

Param: object

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

Returns

  • The value of the "title" property.

Optionaltr

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

Represents the "tr" property of an object.

Typeparam

IField - Represents the object type containing the "tr" property.

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 options for a virtual list box component.

Settings

Member Visibility

On This Page

Properties