Interface ICheckboxFieldProps<Data, Payload>

Interface representing props for the CheckboxField component.

interface ICheckboxFieldProps<Data = IAnything, Payload = IAnything> {
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    readonly?: boolean;
    title?: string;
}

Type Parameters

  • Data = IAnything

    The type of data for the field.

  • Payload = IAnything

    The type of payload for the field.

Hierarchy (View Summary)

Properties

disabled? groupRef? readonly? title?

Properties

Optionaldisabled

disabled?: boolean

Represents the "disabled" property of a field in the given data payload.

Template: Data

The type of the data payload.

Template: Payload

The type of the payload object.

Param: disabled

The value of the "disabled" property.

Returns

OptionalgroupRef

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

Represents the optional property groupRef from the IField interface. The groupRef property is a subset of the PickProp type with the 'groupRef' key.

Optionalreadonly

readonly?: boolean

Retrieves the value of the 'readonly' property from the given object.

Template: Data

The type of data stored in the field.

Template: Payload

The type of payload used in the field.

Template: T

The type of the field object.

Param: field

The field object.

Returns

The value of the 'readonly' property from the field object.

Optionaltitle

title?: string

Retrieves the 'title' property from the given variable.

Template: T

The type of the variable.

Template: K

The key to pick from the variable.

Param: variable

The variable to pick the property from.

Returns

  • The picked property.

Settings

Member Visibility

On This Page

Properties