Function YesNoField

Parameters

• props: IYesNoFieldProps<any, any> & IYesNoFieldPrivate<any>

  The properties of the Yes/No field component.

  Interface representing the props for the YesNoField component.

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

    Represents the groupRef property of an object.

  • OptionallabelShrink?: boolean

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

  • OptionalnoDeselect?: 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?: 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?: 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?: 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?: 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?:
        | (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?: 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 options for a virtual list box component.

  Represents a private interface for a Yes/No field

  • dirty: boolean

  • incorrect: null | string

  • invalid: null | string

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

  • readonly: boolean

  • value: any