Function SwitchField

Parameters

• props: ISwitchFieldProps<any, any> & ISwitchFieldPrivate<any>

  The properties for the Switch field.

  Represents the properties for a switch field component.

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

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

  • Optionalreadonly?: boolean

    Represents the readonly property of an IField object.

  • OptionalswitchActiveLabel?: 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?: boolean

    The switchNoColor property of the Field interface.

  • Optionaltitle?: 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.

  Represents a private interface for a switch field.

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

  • value: any