Interface ISwitchFieldProps<Data, Payload>

Represents the properties for a switch field component.

interface ISwitchFieldProps<Data = IAnything, Payload = IAnything> {
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    readonly?: boolean;
    switchActiveLabel?: string;
    switchNoColor?: 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? switchActiveLabel? switchNoColor? title?

Properties

Optionaldisabled

disabled?: boolean

Represents the 'disabled' property of a field in a form.

Template: Data

The data type associated with the form.

Template: Payload

The payload type associated with the form.

OptionalgroupRef

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

Retrieves the 'groupRef' property from an object based on the given type.

Type declaration

    • (element?: null | HTMLDivElement): void

    • Parameters

      • Optionalelement: null | HTMLDivElement

      Returns void

      • The 'groupRef' property from the given object.

Optionalreadonly

readonly?: boolean

Represents the readonly property of an IField object.

OptionalswitchActiveLabel

switchActiveLabel?: string

Gets the value of the switchActiveLabel property from the given field.

Param: field

The field object from which to get the switchActiveLabel property.

Returns

  • The value of the switchActiveLabel property.

OptionalswitchNoColor

switchNoColor?: boolean

The switchNoColor property of the Field interface.

Optionaltitle

title?: string

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

Template: Data

The type of the data contained in the field.

Template: Payload

The type of the payload associated with the field.

Param: field

An object of type IField<Data, Payload>.

Returns

  • The value of the 'title' property from the given field.

Settings

Member Visibility

On This Page

Properties