Interface IRadioFieldProps<Data, Payload>

Interface for defining props of a radio field component.

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

Type Parameters

Hierarchy (View Summary)

Properties

disabled? groupRef? radioValue? readonly? title?

Properties

Optionaldisabled

disabled?: boolean

Represents the 'disabled' property of a field.

The 'disabled' property determines whether a field is disabled or not. If set to true, the field will be disabled and the user will not be able to interact with it.

Template: Data

The type of data passed to the field.

Template: Payload

The type of payload received by the field.

OptionalgroupRef

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

Represents a reference to a group in a field object.

OptionalradioValue

radioValue?: string

Represents the radio value of a field.

Optionalreadonly

readonly?: boolean

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

Description

This property represents the "readonly" attribute of a field. It is used to indicate whether a field is read-only or not.

The value of this property is derived from the "IField" interface in the "Data" module and the "Payload" type.

Optionaltitle

title?: string

Type definition for the "title" property of an object. It is a generic type that picks the "title" property from a given object type.

Template: IField

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

Template: Data

The data type of the object.

Template: Payload

The payload type of the object.

Settings

Member Visibility

On This Page

Properties